1 /**
2 * Copyright 2010 The Kuali Foundation Licensed under the
3 * Educational Community License, Version 2.0 (the "License"); you may
4 * not use this file except in compliance with the License. You may
5 * obtain a copy of the License at
6 *
7 * http://www.osedu.org/licenses/ECL-2.0
8 *
9 * Unless required by applicable law or agreed to in writing,
10 * software distributed under the License is distributed on an "AS IS"
11 * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12 * or implied. See the License for the specific language governing
13 * permissions and limitations under the License.
14 */
15
16 package org.kuali.student.lum.lo.dto;
17
18 import java.io.Serializable;
19 import java.util.Date;
20 import java.util.HashMap;
21 import java.util.Map;
22
23 import javax.xml.bind.annotation.XmlAccessType;
24 import javax.xml.bind.annotation.XmlAccessorType;
25 import javax.xml.bind.annotation.XmlAttribute;
26 import javax.xml.bind.annotation.XmlElement;
27 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
28
29 import org.kuali.student.common.dto.MetaInfo;
30 import org.kuali.student.core.ws.binding.JaxbAttributeMapListAdapter;
31
32 /**
33 *
34 *
35 * @Author KSContractMojo
36 * @Author jimt
37 * @Since Tue Dec 08 10:01:34 PST 2009
38 * @See <a href="https://test.kuali.org/confluence/display/KULSTU/loLoRelationInfo+Structure+v1.0-rc2">LoLoRelationInfo</>
39 *
40 */
41 @XmlAccessorType(XmlAccessType.FIELD)
42 public class LoLoRelationInfo implements Serializable {
43
44 private static final long serialVersionUID = 1L;
45
46 @XmlElement
47 private String loId;
48
49 @XmlElement
50 private String relatedLoId;
51
52 @XmlElement
53 private Date effectiveDate;
54
55 @XmlElement
56 private Date expirationDate;
57
58 @XmlElement
59 @XmlJavaTypeAdapter(JaxbAttributeMapListAdapter.class)
60 private Map<String, String> attributes;
61
62 @XmlElement
63 private MetaInfo metaInfo;
64
65 @XmlAttribute
66 private String type;
67
68 @XmlAttribute
69 private String state;
70
71 @XmlAttribute
72 private String id;
73
74 /**
75 * Unique identifier for a learning objective record. This is the "From" or "Parent" in the relation.
76 */
77 public String getLoId() {
78 return loId;
79 }
80
81 public void setLoId(String loId) {
82 this.loId = loId;
83 }
84
85 /**
86 * Unique identifier for a learning objective record. This is the "To" or "Child" of the relation.
87 */
88 public String getRelatedLoId() {
89 return relatedLoId;
90 }
91
92 public void setRelatedLoId(String relatedLoId) {
93 this.relatedLoId = relatedLoId;
94 }
95
96 /**
97 * Date and time that this LO to LO relationship 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.
98 */
99 public Date getEffectiveDate() {
100 return effectiveDate;
101 }
102
103 public void setEffectiveDate(Date effectiveDate) {
104 this.effectiveDate = effectiveDate;
105 }
106
107 /**
108 * Date and time that this LO to LO relationship 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.
109 */
110 public Date getExpirationDate() {
111 return expirationDate;
112 }
113
114 public void setExpirationDate(Date expirationDate) {
115 this.expirationDate = expirationDate;
116 }
117
118 /**
119 * List of key/value pairs, typically used for dynamic attributes.
120 */
121 public Map<String, String> getAttributes() {
122 if (attributes == null) {
123 attributes = new HashMap<String, String>();
124 }
125 return attributes;
126 }
127
128 public void setAttributes(Map<String, String> attributes) {
129 this.attributes = attributes;
130 }
131
132 /**
133 * 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.
134 */
135 public MetaInfo getMetaInfo() {
136 return metaInfo;
137 }
138
139 public void setMetaInfo(MetaInfo metaInfo) {
140 this.metaInfo = metaInfo;
141 }
142
143 /**
144 * Unique identifier for the LO to LO relation type.
145 */
146 public String getType() {
147 return type;
148 }
149
150 public void setType(String type) {
151 this.type = type;
152 }
153
154 /**
155 * Identifier for the current status of a LO to LO relationship. The values for this field are constrained to those in the luLuRelationState enumeration. A separate setup operation does not exist for retrieval of the meta data around this value.
156 */
157 public String getState() {
158 return state;
159 }
160
161 public void setState(String state) {
162 this.state = state;
163 }
164
165 /**
166 * Unique identifier for a LO to LO relationship. This is optional, due to the identifier being set at the time of creation. Once the relation has been created, this should be seen as required.
167 */
168 public String getId() {
169 return id;
170 }
171
172 public void setId(String id) {
173 this.id = id;
174 }
175 }