/**
    * Copyright 2010 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.student.core.comment.dto;
  
  import java.io.Serializable;
  import java.util.Date;
  import java.util.HashMap;
  import java.util.Map;
  
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAttribute;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  
  import org.kuali.student.common.dto.HasAttributes;
  import org.kuali.student.common.dto.HasTypeState;
  import org.kuali.student.common.dto.Idable;
  import org.kuali.student.common.dto.MetaInfo;
  import org.kuali.student.common.dto.RichTextInfo;
  import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
  
  /**
   * Detailed information about a comment.
   *
   * @Author KSContractMojo
   * @Author Neerav Agrawal
   * @Since Fri Jun 05 14:27:31 EDT 2009
   * @See <a href="https://test.kuali.org/confluence/display/KULSTR/commentInfo+Structure+v1.0-rc1">CommentInfo</>
   *
   */
  @XmlAccessorType(XmlAccessType.FIELD)
  public class CommentInfo implements Serializable, Idable, HasTypeState, HasAttributes {
  
      private static final long serialVersionUID = 1L;
  
      @XmlElement
      private RichTextInfo commentText;
  
      @XmlElement
      private String referenceTypeKey;
  
      @XmlElement
      private String referenceId;
  
      @XmlElement
      private Date effectiveDate;
  
      @XmlElement
      private Date expirationDate;
  
      @XmlElement
      @XmlJavaTypeAdapter(JaxbAttributeMapListAdapter.class)
      private Map<String, String> attributes;
  
      @XmlElement
      private MetaInfo metaInfo;
  
      @XmlAttribute
      private String type;
  
      @XmlAttribute
      private String state;
  
      @XmlAttribute
      private String id;
  
      /**
       * Narrative text of the comment
       */
      public RichTextInfo getCommentText() {
          return commentText;
      }
  
      public void setCommentText(RichTextInfo commentText) {
          this.commentText = commentText;
      }
  
      /**
       * Unique identifier for a reference type.
       */
      public String getReferenceTypeKey() {
          return referenceTypeKey;
      }
  
      public void setReferenceTypeKey(String referenceTypeKey) {
         this.referenceTypeKey = referenceTypeKey;
     }
 
     /**
      * Identifier component for a reference. This is an external identifier and such may not uniquely identify a particular reference unless combined with the type. A referenceId could be a cluId, a luiId, an orgId, a documentId, etc.
      */
     public String getReferenceId() {
         return referenceId;
     }
 
     public void setReferenceId(String referenceId) {
         this.referenceId = referenceId;
     }
 
     /**
      * Date and time that this comment became effective. This is a similar concept to the effective date on enumerated values. When an expiration date has been specified, this field must be less than or equal to the expiration date.
      */
     public Date getEffectiveDate() {
         return effectiveDate;
     }
 
     public void setEffectiveDate(Date effectiveDate) {
         this.effectiveDate = effectiveDate;
     }
 
     /**
      * Date and time that this comment expires. This is a similar concept to the expiration date on enumerated values. If specified, this should be greater than or equal to the effective date. If this field is not specified, then no expiration date has been currently defined and should automatically be considered greater than the effective date.
      */
     public Date getExpirationDate() {
         return expirationDate;
     }
 
     public void setExpirationDate(Date expirationDate) {
         this.expirationDate = expirationDate;
     }
 
     /**
      * List of key/value pairs, typically used for dynamic attributes.
      */
     public Map<String, String> getAttributes() {
         if (attributes == null) {
             attributes = new HashMap<String, String>();
         }
         return attributes;
     }
 
     public void setAttributes(Map<String, String> attributes) {
         this.attributes = attributes;
     }
 
     /**
      * Create and last update info for the structure. This is optional and treated as read only since the data is set by the internals of the service during maintenance operations.
      */
     public MetaInfo getMetaInfo() {
         return metaInfo;
     }
 
     public void setMetaInfo(MetaInfo metaInfo) {
         this.metaInfo = metaInfo;
     }
 
     /**
      * Unique identifier for a comment type.
      */
     public String getType() {
         return type;
     }
 
     public void setType(String type) {
         this.type = type;
     }
 
     /**
      * The current status of the comment. The values for this field are constrained to those in the commentState enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.
      */
     public String getState() {
         return state;
     }
 
     public void setState(String state) {
         this.state = state;
     }
 
     /**
      * Unique identifier for a comment. This is optional, due to the identifier being set at the time of creation. Once the comment has been created, this should be seen as required.
      */
     public String getId() {
         return id;
     }
 
     public void setId(String id) {
         this.id = id;
     }
 }