/**
    * Copyright 2011-2013 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.writer.entity;
  
  import java.util.Date;
  
  import javax.persistence.*;
  
  /**
   * A class representing a comment placed on an article.
   * @author Kuali Mobility Team (mobility.collab@kuali.org)
   * @since 3.0.0
   */
  @NamedQueries({
      @NamedQuery(
              name = "Comment.getCommentsForArticle",
              query = "SELECT c FROM Comment c WHERE article_id = :articleId ORDER BY c.timestamp DESC"),
      @NamedQuery(
              name = "Comment.deleteComment",
              query = "DELETE Comment WHERE id = :commentId"
      )
  })
  @Entity
  @Table(name="WRITER_COMMENT")
  public class Comment {
  
  	/** Display name for the user that created the comment */
  	@Column(name="USER_DISPLAY_NAME", nullable=false, length=128)
  	private String userDisplayName;
  	
  	/** Primary key of the comment */
  	@Id
  	@GeneratedValue(strategy = GenerationType.TABLE)
      @Column(name="ID")
  	private Long id;
  	
  	/** Id of the article on which this comment is placed */
  	@Column(name="ARTICLE_ID", nullable=false)
  	private long articleId;
  	
  	/** Timestamp of when the comment was placed */
  	@Column(name="TIMESTAMP", nullable=false)
  	private Date timestamp;
  	
  	/** Title of the comment */
  	@Column(name="TITLE", nullable=false, length=64)
  	private String title;
  	
  	/** The comment text */
  	@Column(name="TEXT", nullable=false, length=250)
  	private String text;
  
      /** Version number for the comment */
  	@Version
  	@Column(name="VER_NBR")
  	protected long versionNumber;
  
  	/**
  	 * @return the userDisplayName
  	 */
  	public String getUserDisplayName() {
  		return userDisplayName;
  	}
  
  	/**
  	 * @param userDisplayName the userDisplayName to set
  	 */
  	public void setUserDisplayName(String userDisplayName) {
  		this.userDisplayName = userDisplayName;
  	}
  
  	/**
  	 * @return the id
  	 */
  	public Long getId() {
  		return id;
  	}
  
  	/**
  	 * @param id the id to set
  	 */
  	public void setId(Long id) {
  		this.id = id;
  	}
  
  	/**
 	 * @return the articleId
 	 */
 	public long getArticleId() {
 		return articleId;
 	}
 
 	/**
 	 * @param articleId the articleId to set
 	 */
 	public void setArticleId(long articleId) {
 		this.articleId = articleId;
 	}
 
 	/**
 	 * @return the timestamp
 	 */
 	public Date getTimestamp() {
 		return timestamp;
 	}
 
 	/**
 	 * @param timestamp the timestamp to set
 	 */
 	public void setTimestamp(Date timestamp) {
 		this.timestamp = timestamp;
 	}
 
 	/**
 	 * @return the title
 	 */
 	public String getTitle() {
 		return title;
 	}
 
 	/**
 	 * @param title the title to set
 	 */
 	public void setTitle(String title) {
 		this.title = title;
 	}
 
 	/**
 	 * @return the text
 	 */
 	public String getText() {
 		return text;
 	}
 
 	/**
 	 * @param text the text to set
 	 */
 	public void setText(String text) {
 		this.text = text;
 	}
 	
 	/**
 	 * Sets the version number of the Comment
 	 * @return
 	 */
 	public long getVersionNumber() {
 		return versionNumber;
 	}
 	
 
 	/**
 	 * Gets the version number of the Comment
 	 * @return
 	 */
 	public void setVersionNumber(long versionNumber) {
 		this.versionNumber = versionNumber;
 	}    
 	
 }