/*

  * Copyright 2009 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.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.opensource.org/licenses/ecl1.php

  *

  * 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.document.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;

 /**

  * Information about the object to document relation.

  *

  * @Author KSContractMojo

  * @Author tom

  * @Since Wed Aug 18 12:10:44 EDT 2010

  * @See <a href="https://test.kuali.org/confluence/display/KULSTU/refDocRelationInfo+Structure">RefDocRelationInfo</>

  *

  */

 @XmlAccessorType(XmlAccessType.FIELD)

 public class RefDocRelationInfo implements Serializable, Idable, HasTypeState, HasAttributes {

     private static final long serialVersionUID = 1L;

     @XmlElement

     private String refObjectTypeKey;

     @XmlElement

     private String refObjectId;

     @XmlElement

     private String documentId;

     @XmlElement

     private String title;

     @XmlElement

     private RichTextInfo desc;

     @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;

     /**

      * Unique identifier for an object type. Used to identify the type of object being referred to, so that the id can be resolved.

      */

     public String getRefObjectTypeKey() {

         return refObjectTypeKey;

     }

     public void setRefObjectTypeKey(String refObjectTypeKey) {

         this.refObjectTypeKey = refObjectTypeKey;

     }

     /**

      * Identifier for an object. This will likely require some additional context in order to be resolved, such as the type of object. An objectId could be a cluId, a luiId, an orgId, a documentId, etc.

      */

     public String getRefObjectId() {

         return refObjectId;

     }

     public void setRefObjectId(String refObjectId) {

         this.refObjectId = refObjectId;

     }

     /**

      * Unique identifier for a document.

      */

     public String getDocumentId() {

         return documentId;

     }

     public void setDocumentId(String documentId) {

         this.documentId = documentId;

     }

     /**

      * The title of the document usage in the context of the relation to the object.

      */

     public String getTitle() {

         return title;

     }

     public void setTitle(String title) {

         this.title = title;

     }

     /**

      * The description of the document usage in the context of the relation to the object.

      */

     public RichTextInfo getDesc() {

         return desc;

     }

     public void setDesc(RichTextInfo desc) {

         this.desc = desc;

     }

     /**

      * Date and time that this Object Doc Relation 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 Object Doc Relation 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 an object/document relationship type. Describes the type of usage of the document.

      */

     public String getType() {

         return type;

     }

     public void setType(String type) {

         this.type = type;

     }

     /**

      * The current status of the object to document relationship. The values for this field are constrained to those in the refDocRelationState 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 LU to document relation. This is optional, due to the identifier being set at the time of creation. Once the connection has been created, this should be seen as required.

      */

     public String getId() {

         return id;

     }

     public void setId(String id) {

         this.id = id;

     }

 }