/**
    * Copyright 2011 The Kuali Foundation Licensed under the
    * Educational Community License, Version 2.0 (the "License"); you may
    * not use this file except in compliance with the License. You may
    * obtain a copy of the License at
    *
    * http://www.osedu.org/licenses/ECL-2.0
    *
    * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an "AS IS"
   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
   * or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  
  package org.kuali.mobility.push.entity;
  
  import java.io.Serializable;
  import java.sql.Timestamp;
  
  import javax.persistence.Column;
  import javax.persistence.Entity;
  import javax.persistence.GeneratedValue;
  import javax.persistence.GenerationType;
  import javax.persistence.Id;
  import javax.persistence.NamedQueries;
  import javax.persistence.NamedQuery;
  import javax.persistence.Table;
  import javax.persistence.Version;
  
  /**
   * A class representing a Push Notification message.
   * 
   * @author Kuali Mobility Team (mobility.dev@kuali.org)
   * @since 2.0.0
   */
  
  
  @Entity
  @Table(name="KME_PSH_SNDR_T")
  public class Sender implements Serializable {
  
  	private static final long serialVersionUID = 1594899851834068598L;
  	
  	/**
  	 * ID for this <code>Sender</code> instance.
  	 */
  	@Id
  	@GeneratedValue(strategy = GenerationType.TABLE)
      @Column(name="ID")
      private Long id;	
  	
  	/**
  	 * Name of the sender. Normal text.  
  	 */
      @Column(name="NM")
      private String name;    
      
  	/**
  	 * Hidden denotes whether the sender is visible in the user's Opt-in/Opt-out preferences page.  
  	 */
      @Column(name="HDN")
      private boolean hidden;	
      
  	/**
  	 * shortname of the sender. No whitespace. 
  	 */
      @Column(name="SNM")
      private String shortName;    
  
  	/**
  	 * Description of the sender.  
  	 */
      @Column(name="DSCRP")
      private String description;
  
  	/**
  	 * Username of the person 
  	 */
      @Column(name="USR")
      private String username;
  
  	/**
  	 * Sender Key is used for verification of a given sender it is required when submitting a http POST.
  	 * Typically a 20 character alphanumeric. 
  	 */
      @Column(name="SENDER_KEY")
      private String senderKey;
      
  	/**
  	 * The timestamp of the last update for this <code>Device</code> details.
  	 */
      @Column(name="PST_TS")
      private Timestamp postedTimestamp;    
         
  	/**
  	 * Version number for this <code>Device</code> record
  	 */
      @Version
     @Column(name="VER_NBR")
     private Long versionNumber;
 
 	/**
 	 * Creates a new instance of a <code>Sender</code>
 	 */
     public Sender(){}
 
 	/**
 	 * Gets the ID for this <code>Sender</code>
 	 * @return ID for this <code>Sender</code>
 	 */
 	public Long getId() {
 		return id;
 	}
 
 	/**
 	 * Sets the id
 	 * @param id The URL
 	 */
 	public void setId(Long id) {
 		this.id = id;
 	}
 
 	/**
 	 * Gets the Name for this <code>Sender</code>
 	 * @return Name for this <code>Sender</code>
 	 */
 	public String getName() {
 		return name;
 	}
 
 	/**
 	 * Sets the Name
 	 * @param name The Name
 	 */
 	public void setName(String name) {
 		this.name = name;
 	}
 
 	/**
 	 * Gets the boolean for hidden for this <code>Sender</code>
 	 * @return hidden for this <code>Sender</code>
 	 */
 	public boolean isHidden() {
 		return hidden;
 	}
 
 	/**
 	 * Sets the hidden
 	 * @param hidden The Hidden
 	 */
 	public void setHidden(boolean hidden) {
 		this.hidden = hidden;
 	}
 
 	/**
 	 * Gets the shortName for this <code>Sender</code>
 	 * @return shortName for this <code>Sender</code>
 	 */
 	public String getShortName() {
 		return shortName;
 	}
 
 	/**
 	 * Sets the ShortName
 	 * @param shortName The ShortName
 	 */
 	public void setShortName(String shortName) {
 		this.shortName = shortName;
 	}
 
 	/**
 	 * Gets the description for this <code>Sender</code>
 	 * @return description for this <code>Sender</code>
 	 */
 	public String getDescription() {
 		return description;
 	}
 
 	/**
 	 * Sets the Description
 	 * @param description The Description
 	 */
 	public void setDescription(String description) {
 		this.description = description;
 	}
 
 	/**
 	 * Gets the username for this <code>Sender</code>
 	 * @return username for this <code>Sender</code>
 	 */	
 	public String getUsername() {
 		return username;
 	}
 
 	/**
 	 * Sets the Username
 	 * @param username The Username
 	 */
 	public void setUsername(String username) {
 		this.username = username;
 	}
 
 	/**
 	 * Gets the senderKey for this <code>Sender</code>
 	 * @return senderKey for this <code>Sender</code>
 	 */
 	public String getSenderKey() {
 		return senderKey;
 	}
 
 	/**
 	 * Sets the SenderKey
 	 * @param senderKey The SenderKey
 	 */
 	public void setSenderKey(String senderKey) {
 		this.senderKey = senderKey;
 	}
 
 	/**
 	 * Gets the postedTimestamp for this <code>Sender</code>
 	 * @return postedTimestamp for this <code>Sender</code>
 	 */
 	public Timestamp getPostedTimestamp() {
 		return postedTimestamp;
 	}
 
 	/**
 	 * Sets the PostedTimestamp
 	 * @param postedTiemstamp The PostedTimestamp
 	 */
 	public void setPostedTimestamp(Timestamp postedTimestamp) {
 		this.postedTimestamp = postedTimestamp;
 	}
 
 	/**
 	 * Gets the versionNumber for this <code>Sender</code>
 	 * @return versionNumber for this <code>Sender</code>
 	 */
 	public Long getVersionNumber() {
 		return versionNumber;
 	}
 
 	/**
 	 * Sets the VersionNumber
 	 * @param versionNumber The VersionNumber
 	 */
 	public void setVersionNumber(Long versionNumber) {
 		this.versionNumber = versionNumber;
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * @see java.lang.Object#toString()
 	 */
 	@Override
 	public String toString() {
 		return "\nSender Object:" + 
 				"\nid=" + id + 
 				"\nname=" + name + 
 				"\nshortName=" + shortName + 
 				"\nhidden=" + (hidden?"true":"false") + 
 				"\ndescription=" + description + 
 				"\nusername=" + username + 
 				"\nsenderKey=" + senderKey + 
 				"\npostedTimestamp="+ postedTimestamp + "\n";
 	}
     
 	
     
 }