/******************************************************************************
    * RestUser.java - Client facing domain object
    * 
    * BuckoVidLib - The BuckoSoft Video Library
    * Copyright(c) 2014 - Dick Balaska
    * 
    */
   package com.buckosoft.BuckoVidLib.domain.rest;
   
  import javax.xml.bind.annotation.XmlRootElement;
  
  import com.buckosoft.BuckoVidLib.web.ImageController;
  
  /** Client facing {@link com.buckosoft.BuckoVidLib.domain.User} object.<br>
   * Strip down to just the fields we want to send.
   * @author dick
   * @since 2015-05-04
   */
  @XmlRootElement(name="User")
  public class RestUser {
  	private	String	username = "";
  	private	boolean	admin = false;
  	private	boolean	unrestricted = false;
  	private	boolean	hideRestricted = false;
  	private	int		backgroundFit = ImageController.bgFill;
  	private	int		artShowFit = ImageController.bgFill;
  	private	int		backgroundDelay = 30;
  	private	int		artShowDelay = 10;
  	private	int		findMaxResults = 40;
  
  	/** Get the name of this User
  	 * @return the username
  	 */
  	public String getUsername() {
  		return username;
  	}
  	/** Set the name of this User
  	 * @param username the username to set
  	 */
  	public void setUsername(String username) {
  		this.username = username;
  	}
  	/** Does this User have admin privileges?
  	 * @return the admin
  	 */
  	public boolean isAdmin() {
  		return admin;
  	}
  	/**
  	 * @param admin the admin to set
  	 */
  	public void setAdmin(boolean admin) {
  		this.admin = admin;
  	}
  	/** Can this User browse the restricted sections of the Library?  (Nicholas Flamel is not in there)
  	 * @return the unrestricted
  	 */
  	public boolean isUnrestricted() {
  		return unrestricted;
  	}
  	/**
  	 * @param unrestricted the unrestricted to set
  	 */
  	public void setUnrestricted(boolean unrestricted) {
  		this.unrestricted = unrestricted;
  	}
  	
  	/** Even though this user has access to the Restricted Sections, does he wish to avert his eyes?
  	 * @return the hideRestricted
  	 */
  	public boolean isHideRestricted() {
  		return hideRestricted;
  	}
  	/**
  	 * @param hideRestricted the hideRestricted to set
  	 */
  	public void setHideRestricted(boolean hideRestricted) {
  		this.hideRestricted = hideRestricted;
  	}
  	/** Get the User's preferred background fit as defined in {@link com.buckosoft.BuckoVidLib.web.ImageController}
  	 * @return the backgroundFit
  	 */
  	public int getBackgroundFit() {
  		return backgroundFit;
  	}
  	/**
  	 * @param backgroundFit the backgroundFit to set
  	 */
  	public void setBackgroundFit(int backgroundFit) {
  		this.backgroundFit = backgroundFit;
  	}
  	/**
  	 * @return the artShowFit
  	 */
  	public int getArtShowFit() {
  		return artShowFit;
  	}
  	/**
  	 * @param artShowFit the artShowFit to set
 	 */
 	public void setArtShowFit(int artShowFit) {
 		this.artShowFit = artShowFit;
 	}
 	/**
 	 * @return the backgroundDelay
 	 */
 	public int getBackgroundDelay() {
 		return backgroundDelay;
 	}
 	/**
 	 * @param backgroundDelay the backgroundDelay to set
 	 */
 	public void setBackgroundDelay(int backgroundDelay) {
 		this.backgroundDelay = backgroundDelay;
 	}
 	/** How many seconds to delay between flips when running the ArtShow
 	 * @return the artShowDelay
 	 */
 	public int getArtShowDelay() {
 		return artShowDelay;
 	}
 	/**
 	 * @param artShowDelay the artShowDelay to set
 	 */
 	public void setArtShowDelay(int artShowDelay) {
 		this.artShowDelay = artShowDelay;
 	}
 	/** Maximum number of results returned in a Find
 	 * @return the findMaxResults
 	 */
 	public int getFindMaxResults() {
 		return findMaxResults;
 	}
 	/**
 	 * @param findMaxResults the findMaxResults to set
 	 */
 	public void setFindMaxResults(int findMaxResults) {
 		this.findMaxResults = findMaxResults;
 	}
 }