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.lum.course.dto;
17
18 import java.io.Serializable;
19
20 import javax.xml.bind.annotation.XmlAccessType;
21 import javax.xml.bind.annotation.XmlAccessorType;
22 import javax.xml.bind.annotation.XmlAttribute;
23 import javax.xml.bind.annotation.XmlElement;
24
25 import org.kuali.student.common.dto.Idable;
26
27 /**
28 * Detailed information about the human readable form of a Variation
29 *
30 * @Author KSContractMojo
31 * @Author Kamal
32 * @Since Tue May 18 11:31:11 PDT 2010
33 * @See <a href="https://test.kuali.org/confluence/display/KULSTU/courseVariationInfo+Structure">CourseVariationInfo</>
34 *
35 */
36 @XmlAccessorType(XmlAccessType.FIELD)
37 public class CourseVariationInfo implements Serializable, Idable {
38
39 private static final long serialVersionUID = 1L;
40
41 @XmlElement
42 private String variationTitle;
43
44 @XmlElement
45 private String subjectArea;
46
47 @XmlElement
48 private String courseNumberSuffix;
49
50 @XmlElement
51 private String variationCode;
52
53 @XmlAttribute
54 private String type;
55
56 @XmlAttribute
57 private String id;
58
59 /**
60 * Full name of the variation, commonly used on catalogues
61 */
62 public String getVariationTitle() {
63 return variationTitle;
64 }
65
66 public void setVariationTitle(String variationTitle) {
67 this.variationTitle = variationTitle;
68 }
69
70 /**
71 *
72 */
73 public String getSubjectArea() {
74 return subjectArea;
75 }
76
77 public void setSubjectArea(String subjectArea) {
78 this.subjectArea = subjectArea;
79 }
80
81 /**
82 * The "extra" portion of the code, which usually corresponds with the most detailed part of the number.
83 */
84 public String getCourseNumberSuffix() {
85 return courseNumberSuffix;
86 }
87
88 public void setCourseNumberSuffix(String courseNumberSuffix) {
89 this.courseNumberSuffix = courseNumberSuffix;
90 }
91
92 /**
93 * A number that indicates the sequence or order of variation in cases where several different variations have the same offical Identifier
94 */
95 public String getVariationCode() {
96 return variationCode;
97 }
98
99 public void setVariationCode(String variationCode) {
100 this.variationCode = variationCode;
101 }
102
103 /**
104 * This is the CluIdentifier Type. It can only have a single value for VariationType
105 */
106 public String getType() {
107 return type;
108 }
109
110 public void setType(String type) {
111 this.type = type;
112 }
113
114 /**
115 * Identifies the particular identifier structure. This is set by the service to be able to determine changes and alterations to the structure as well as provides a handle for searches. This structure is not accessible through unique operations, and it is strongly recommended that no external references to this particular identifier be maintained.
116 */
117 public String getId() {
118 return id;
119 }
120
121 public void setId(String id) {
122 this.id = id;
123 }
124 }