Clover Coverage Report - Kuali Student 1.2-M1-SNAPSHOT (Aggregated)
Coverage timestamp: Fri Mar 4 2011 04:03:38 EST
../../../../../../img/srcFileCovDistChart10.png 0% of files have more coverage
24   210   23   1.09
2   114   0.96   22
22     1.05  
1    
 
  DocumentInfo       Line # 49 24 0% 23 0 100% 1.0
 
  (4)
 
1    /*
2    * Copyright 2009 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 1.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl1.php
9    *
10    * Unless required by applicable law or agreed to in writing, software
11    * distributed under the License is distributed on an "AS IS" BASIS,
12    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13    * See the License for the specific language governing permissions and
14    * limitations under the License.
15    */
16    package org.kuali.student.core.document.dto;
17   
18    import java.io.Serializable;
19    import java.util.ArrayList;
20    import java.util.Date;
21    import java.util.HashMap;
22    import java.util.List;
23    import java.util.Map;
24   
25    import javax.xml.bind.annotation.XmlAccessType;
26    import javax.xml.bind.annotation.XmlAccessorType;
27    import javax.xml.bind.annotation.XmlAttribute;
28    import javax.xml.bind.annotation.XmlElement;
29    import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
30   
31    import org.kuali.student.common.dto.HasAttributes;
32    import org.kuali.student.common.dto.HasTypeState;
33    import org.kuali.student.common.dto.Idable;
34    import org.kuali.student.common.dto.MetaInfo;
35    import org.kuali.student.common.dto.RichTextInfo;
36    import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
37   
38   
39    /**
40    * Detailed information about a document.
41    *
42    * @Author KSContractMojo
43    * @Author tom
44    * @Since Wed Aug 18 12:10:38 EDT 2010
45    * @See <a href="https://test.kuali.org/confluence/display/KULSTU/documentInfo+Structure">DocumentInfo</>
46    *
47    */
48    @XmlAccessorType(XmlAccessType.FIELD)
 
49    public class DocumentInfo implements Serializable, Idable, HasTypeState, HasAttributes {
50   
51    private static final long serialVersionUID = 1L;
52   
53    @XmlElement
54    private String name;
55   
56    @XmlElement
57    private String fileName;
58   
59    @XmlElement
60    private RichTextInfo desc;
61   
62    @XmlElement
63    private DocumentBinaryInfo documentBinaryInfo;
64   
65    @XmlElement
66    private Date effectiveDate;
67   
68    @XmlElement
69    private Date expirationDate;
70   
71    @XmlElement
72    @XmlJavaTypeAdapter(JaxbAttributeMapListAdapter.class)
73    private Map<String, String> attributes;
74   
75    @XmlElement
76    private MetaInfo metaInfo;
77   
78    @XmlAttribute
79    private String type;
80   
81    @XmlAttribute
82    private String state;
83   
84    @XmlAttribute
85    private String id;
86   
87    /**
88    * Friendly name of the document
89    */
 
90  7 toggle public String getName() {
91  7 return name;
92    }
93   
 
94  12 toggle public void setName(String name) {
95  12 this.name = name;
96    }
97   
98    /**
99    * Name of the document file
100    */
 
101  8 toggle public String getFileName() {
102  8 return fileName;
103    }
104   
 
105  13 toggle public void setFileName(String fileName) {
106  13 this.fileName = fileName;
107    }
108   
109    /**
110    * Narrative description of the document
111    */
 
112  9 toggle public RichTextInfo getDesc() {
113  9 return desc;
114    }
115   
 
116  12 toggle public void setDesc(RichTextInfo desc) {
117  12 this.desc = desc;
118    }
119   
120    /**
121    * The encoded document. The expectation is that this could be a base64 encoding.
122    */
 
123  18 toggle public DocumentBinaryInfo getDocumentBinaryInfo() {
124  18 return documentBinaryInfo;
125    }
126   
 
127  13 toggle public void setDocumentBinaryInfo(DocumentBinaryInfo documentBinaryInfo) {
128  13 this.documentBinaryInfo = documentBinaryInfo;
129    }
130   
131    /**
132    * Date and time that this document 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.
133    */
 
134  8 toggle public Date getEffectiveDate() {
135  8 return effectiveDate;
136    }
137   
 
138  12 toggle public void setEffectiveDate(Date effectiveDate) {
139  12 this.effectiveDate = effectiveDate;
140    }
141   
142    /**
143    * Date and time that this document 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.
144    */
 
145  8 toggle public Date getExpirationDate() {
146  8 return expirationDate;
147    }
148   
 
149  12 toggle public void setExpirationDate(Date expirationDate) {
150  12 this.expirationDate = expirationDate;
151    }
152   
153    /**
154    * List of key/value pairs, typically used for dynamic attributes.
155    */
 
156  6 toggle public Map<String, String> getAttributes() {
157  6 if (attributes == null) {
158  3 attributes = new HashMap<String, String>();
159    }
160  6 return attributes;
161    }
162   
 
163  11 toggle public void setAttributes(Map<String, String> attributes) {
164  11 this.attributes = attributes;
165    }
166   
167    /**
168    * 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.
169    */
 
170  3 toggle public MetaInfo getMetaInfo() {
171  3 return metaInfo;
172    }
173   
 
174  10 toggle public void setMetaInfo(MetaInfo metaInfo) {
175  10 this.metaInfo = metaInfo;
176    }
177   
178    /**
179    * Unique identifier for a document type.
180    */
 
181  2 toggle public String getType() {
182  2 return type;
183    }
184   
 
185  12 toggle public void setType(String type) {
186  12 this.type = type;
187    }
188   
189    /**
190    * The current status of the document. The values for this field are constrained to those in the documentState enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.
191    */
 
192  6 toggle public String getState() {
193  6 return state;
194    }
195   
 
196  11 toggle public void setState(String state) {
197  11 this.state = state;
198    }
199   
200    /**
201    * Unique identifier for a document. This is optional, due to the identifier being set at the time of creation. Once the document has been created, this should be seen as required.
202    */
 
203  12 toggle public String getId() {
204  12 return id;
205    }
206   
 
207  10 toggle public void setId(String id) {
208  10 this.id = id;
209    }
210    }