1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 package org.kuali.rice.kim.api.identity.affiliation;
17
18 import org.apache.commons.lang.StringUtils;
19 import org.joda.time.DateTime;
20 import org.kuali.rice.core.api.CoreConstants;
21 import org.kuali.rice.core.api.mo.AbstractDataTransferObject;
22 import org.kuali.rice.core.api.mo.ModelBuilder;
23 import org.kuali.rice.core.api.mo.common.active.InactivatableFromToUtils;
24 import org.kuali.rice.core.api.util.jaxb.DateTimeAdapter;
25 import org.w3c.dom.Element;
26
27 import javax.xml.bind.annotation.XmlAccessType;
28 import javax.xml.bind.annotation.XmlAccessorType;
29 import javax.xml.bind.annotation.XmlAnyElement;
30 import javax.xml.bind.annotation.XmlElement;
31 import javax.xml.bind.annotation.XmlRootElement;
32 import javax.xml.bind.annotation.XmlType;
33 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
34 import java.io.Serializable;
35 import java.util.Collection;
36
37 @XmlRootElement(name = EntityAffiliationHistory.Constants.ROOT_ELEMENT_NAME)
38 @XmlAccessorType(XmlAccessType.NONE)
39 @XmlType(name = EntityAffiliationHistory.Constants.TYPE_NAME, propOrder = {
40 EntityAffiliationHistory.Elements.ID,
41 EntityAffiliationHistory.Elements.ENTITY_ID,
42 EntityAffiliationHistory.Elements.AFFILIATION_TYPE,
43 EntityAffiliationHistory.Elements.CAMPUS_CODE,
44 EntityAffiliationHistory.Elements.DEFAULT_VALUE,
45 EntityAffiliationHistory.Elements.ACTIVE,
46 CoreConstants.CommonElements.HISTORY_ID,
47 CoreConstants.CommonElements.ACTIVE_FROM_DATE,
48 CoreConstants.CommonElements.ACTIVE_TO_DATE,
49 CoreConstants.CommonElements.VERSION_NUMBER,
50 CoreConstants.CommonElements.OBJECT_ID,
51 CoreConstants.CommonElements.FUTURE_ELEMENTS
52 })
53 public final class EntityAffiliationHistory extends AbstractDataTransferObject
54 implements EntityAffiliationHistoryContract
55 {
56
57 @XmlElement(name = Elements.ENTITY_ID, required = false)
58 private final String entityId;
59 @XmlElement(name = Elements.AFFILIATION_TYPE, required = false)
60 private final EntityAffiliationTypeHistory affiliationType;
61 @XmlElement(name = Elements.CAMPUS_CODE, required = false)
62 private final String campusCode;
63 @XmlElement(name = CoreConstants.CommonElements.VERSION_NUMBER, required = false)
64 private final Long versionNumber;
65 @XmlElement(name = CoreConstants.CommonElements.OBJECT_ID, required = false)
66 private final String objectId;
67 @XmlElement(name = Elements.DEFAULT_VALUE, required = false)
68 private final boolean defaultValue;
69 @XmlElement(name = Elements.ACTIVE, required = false)
70 private final boolean active;
71 @XmlElement(name = Elements.ID, required = false)
72 private final String id;
73 @XmlElement(name = CoreConstants.CommonElements.HISTORY_ID, required = false)
74 private final Long historyId;
75 @XmlElement(name = CoreConstants.CommonElements.ACTIVE_FROM_DATE, required = false)
76 @XmlJavaTypeAdapter(DateTimeAdapter.class)
77 private final DateTime activeFromDate;
78 @XmlElement(name = CoreConstants.CommonElements.ACTIVE_TO_DATE, required = false)
79 @XmlJavaTypeAdapter(DateTimeAdapter.class)
80 private final DateTime activeToDate;
81 @SuppressWarnings("unused")
82 @XmlAnyElement
83 private final Collection<Element> _futureElements = null;
84
85
86
87
88
89 private EntityAffiliationHistory() {
90 this.entityId = null;
91 this.affiliationType = null;
92 this.campusCode = null;
93 this.versionNumber = null;
94 this.objectId = null;
95 this.defaultValue = false;
96 this.active = false;
97 this.id = null;
98 this.historyId = null;
99 this.activeFromDate = null;
100 this.activeToDate = null;
101 }
102
103 private EntityAffiliationHistory(Builder builder) {
104 this.entityId = builder.getEntityId();
105 this.affiliationType = builder.getAffiliationType() != null ? builder.getAffiliationType().build() : null;
106 this.campusCode = builder.getCampusCode();
107 this.versionNumber = builder.getVersionNumber();
108 this.objectId = builder.getObjectId();
109 this.defaultValue = builder.isDefaultValue();
110 this.active = builder.isActive();
111 this.id = builder.getId();
112 this.historyId = builder.getHistoryId();
113 this.activeFromDate = builder.getActiveFromDate();
114 this.activeToDate = builder.getActiveToDate();
115 }
116
117 @Override
118 public String getEntityId() {
119 return this.entityId;
120 }
121
122 @Override
123 public EntityAffiliationTypeHistory getAffiliationType() {
124 return this.affiliationType;
125 }
126
127 @Override
128 public String getCampusCode() {
129 return this.campusCode;
130 }
131
132 @Override
133 public Long getVersionNumber() {
134 return this.versionNumber;
135 }
136
137 @Override
138 public String getObjectId() {
139 return this.objectId;
140 }
141
142 @Override
143 public boolean isDefaultValue() {
144 return this.defaultValue;
145 }
146
147 @Override
148 public boolean isActive() {
149 return this.active;
150 }
151
152 @Override
153 public String getId() {
154 return this.id;
155 }
156
157 @Override
158 public Long getHistoryId() {
159 return this.historyId;
160 }
161
162 @Override
163 public DateTime getActiveFromDate() {
164 return this.activeFromDate;
165 }
166
167 @Override
168 public DateTime getActiveToDate() {
169 return this.activeToDate;
170 }
171
172 @Override
173 public boolean isActiveNow() {
174 return isActive() && InactivatableFromToUtils.isActive(activeFromDate, activeToDate, null);
175 }
176
177 @Override
178 public boolean isActive(DateTime activeAsOf) {
179 return isActive() && InactivatableFromToUtils.isActive(activeFromDate, activeToDate, activeAsOf);
180 }
181
182
183
184
185
186 public final static class Builder
187 implements Serializable, ModelBuilder, EntityAffiliationHistoryContract
188 {
189
190 private String entityId;
191 private EntityAffiliationTypeHistory.Builder affiliationType;
192 private String campusCode;
193 private Long versionNumber;
194 private String objectId;
195 private boolean defaultValue;
196 private boolean active;
197 private String id;
198 private Long historyId;
199 private DateTime activeFromDate;
200 private DateTime activeToDate;
201
202
203 private Builder() { }
204
205 public static Builder create() {
206 return new Builder();
207 }
208
209 public static Builder create(EntityAffiliationHistoryContract contract) {
210 if (contract == null) {
211 throw new IllegalArgumentException("contract was null");
212 }
213 Builder builder = create();
214 builder.setEntityId(contract.getEntityId());
215 if (contract.getAffiliationType() != null) {
216 builder.setAffiliationType(EntityAffiliationTypeHistory.Builder.create(contract.getAffiliationType()));
217 }
218 builder.setCampusCode(contract.getCampusCode());
219 builder.setVersionNumber(contract.getVersionNumber());
220 builder.setObjectId(contract.getObjectId());
221 builder.setDefaultValue(contract.isDefaultValue());
222 builder.setActive(contract.isActive());
223 builder.setId(contract.getId());
224 builder.setHistoryId(contract.getHistoryId());
225 builder.setActiveFromDate(contract.getActiveFromDate());
226 builder.setActiveToDate(contract.getActiveToDate());
227 return builder;
228 }
229
230 public EntityAffiliationHistory build() {
231 return new EntityAffiliationHistory(this);
232 }
233
234 @Override
235 public String getEntityId() {
236 return this.entityId;
237 }
238
239 @Override
240 public EntityAffiliationTypeHistory.Builder getAffiliationType() {
241 return this.affiliationType;
242 }
243
244 @Override
245 public String getCampusCode() {
246 return this.campusCode;
247 }
248
249 @Override
250 public Long getVersionNumber() {
251 return this.versionNumber;
252 }
253
254 @Override
255 public String getObjectId() {
256 return this.objectId;
257 }
258
259 @Override
260 public boolean isDefaultValue() {
261 return this.defaultValue;
262 }
263
264 @Override
265 public boolean isActive() {
266 return this.active;
267 }
268
269 @Override
270 public String getId() {
271 return this.id;
272 }
273
274 @Override
275 public Long getHistoryId() {
276 return this.historyId;
277 }
278
279 @Override
280 public boolean isActiveNow() {
281 return isActive() && InactivatableFromToUtils.isActive(activeFromDate, activeToDate, null);
282 }
283
284 @Override
285 public boolean isActive(DateTime activeAsOf) {
286 return isActive() && InactivatableFromToUtils.isActive(activeFromDate, activeToDate, activeAsOf);
287 }
288
289 @Override
290 public DateTime getActiveFromDate() {
291 return this.activeFromDate;
292 }
293
294 @Override
295 public DateTime getActiveToDate() {
296 return this.activeToDate;
297 }
298
299 public void setEntityId(String entityId) {
300 this.entityId = entityId;
301 }
302
303 public void setAffiliationType(EntityAffiliationTypeHistory.Builder affiliationType) {
304 this.affiliationType = affiliationType;
305 }
306
307 public void setCampusCode(String campusCode) {
308 this.campusCode = campusCode;
309 }
310
311 public void setVersionNumber(Long versionNumber) {
312 this.versionNumber = versionNumber;
313 }
314
315 public void setObjectId(String objectId) {
316 this.objectId = objectId;
317 }
318
319 public void setDefaultValue(boolean defaultValue) {
320 this.defaultValue = defaultValue;
321 }
322
323 public void setActive(boolean active) {
324 this.active = active;
325 }
326
327 public void setId(String id) {
328 if (StringUtils.isWhitespace(id)) {
329 throw new IllegalArgumentException("id is blank");
330 }
331 this.id = id;
332 }
333
334 public void setHistoryId(Long historyId) {
335 this.historyId = historyId;
336 }
337
338 public void setActiveFromDate(DateTime activeFromDate) {
339 this.activeFromDate = activeFromDate;
340 }
341
342 public void setActiveToDate(DateTime activeToDate) {
343 this.activeToDate = activeToDate;
344 }
345
346 }
347
348
349
350
351
352
353 static class Constants {
354
355 final static String ROOT_ELEMENT_NAME = "entityAffiliation";
356 final static String TYPE_NAME = "EntityAffiliationType";
357 }
358
359
360
361
362
363
364 static class Elements {
365
366 final static String ENTITY_ID = "entityId";
367 final static String AFFILIATION_TYPE = "affiliationType";
368 final static String CAMPUS_CODE = "campusCode";
369 final static String DEFAULT_VALUE = "defaultValue";
370 final static String ACTIVE = "active";
371 final static String ID = "id";
372
373 }
374
375 }