1 /*
2 * This class is an auto-generated source file for a HAPI
3 * HL7 v2.x standard structure class.
4 *
5 * For more information, visit: http://hl7api.sourceforge.net/
6 *
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * (the "License"); you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
12 * specific language governing rights and limitations under the License.
13 *
14 * The Original Code is "[file_name]". Description:
15 * "[one_line_description]"
16 *
17 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
18 * 2012. All Rights Reserved.
19 *
20 * Contributor(s): ______________________________________.
21 *
22 * Alternatively, the contents of this file may be used under the terms of the
23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are
24 * applicable instead of those above. If you wish to allow use of your version of this
25 * file only under the terms of the GPL and not to allow others to use your version
26 * of this file under the MPL, indicate your decision by deleting the provisions above
27 * and replace them with the notice and other provisions required by the GPL License.
28 * If you do not delete the provisions above, a recipient may use your version of
29 * this file under either the MPL or the GPL.
30 *
31 */
32
33
34 package ca.uhn.hl7v2.model.v27.group;
35
36 import ca.uhn.hl7v2.model.v27.segment.*;
37
38 import ca.uhn.hl7v2.HL7Exception;
39 import ca.uhn.hl7v2.parser.ModelClassFactory;
40 import ca.uhn.hl7v2.model.*;
41
42 /**
43 * <p>Represents a CSU_C09_STUDY_SCHEDULE group structure (a Group object).
44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45 * This Group contains the following elements:
46 * </p>
47 * <ul>
48 * <li>1: CSS (Clinical Study Data Schedule Segment) <b>optional </b></li>
49 * <li>2: CSU_C09_STUDY_OBSERVATION (a Group object) <b> repeating </b></li>
50 * <li>3: CSU_C09_STUDY_PHARM (a Group object) <b> repeating </b></li>
51 * </ul>
52 */
53 //@SuppressWarnings("unused")
54 public class CSU_C09_STUDY_SCHEDULE extends AbstractGroup {
55
56 /**
57 * Creates a new CSU_C09_STUDY_SCHEDULE group
58 */
59 public CSU_C09_STUDY_SCHEDULE(Group parent, ModelClassFactory factory) {
60 super(parent, factory);
61 init(factory);
62 }
63
64 private void init(ModelClassFactory factory) {
65 try {
66 this.add(CSS.class, false, false, false);
67 this.add(CSU_C09_STUDY_OBSERVATION.class, true, true, false);
68 this.add(CSU_C09_STUDY_PHARM.class, true, true, false);
69 } catch(HL7Exception e) {
70 log.error("Unexpected error creating CSU_C09_STUDY_SCHEDULE - this is probably a bug in the source code generator.", e);
71 }
72 }
73
74 /**
75 * Returns "2.7"
76 */
77 public String getVersion() {
78 return "2.7";
79 }
80
81
82
83 /**
84 * Returns
85 * CSS (Clinical Study Data Schedule Segment) - creates it if necessary
86 */
87 public CSS getCSS() {
88 CSS retVal = getTyped("CSS", CSS.class);
89 return retVal;
90 }
91
92
93
94
95 /**
96 * Returns
97 * the first repetition of
98 * STUDY_OBSERVATION (a Group object) - creates it if necessary
99 */
100 public CSU_C09_STUDY_OBSERVATION getSTUDY_OBSERVATION() {
101 CSU_C09_STUDY_OBSERVATION retVal = getTyped("STUDY_OBSERVATION", CSU_C09_STUDY_OBSERVATION.class);
102 return retVal;
103 }
104
105
106 /**
107 * Returns a specific repetition of
108 * STUDY_OBSERVATION (a Group object) - creates it if necessary
109 *
110 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
111 * @throws HL7Exception if the repetition requested is more than one
112 * greater than the number of existing repetitions.
113 */
114 public CSU_C09_STUDY_OBSERVATION getSTUDY_OBSERVATION(int rep) {
115 CSU_C09_STUDY_OBSERVATION retVal = getTyped("STUDY_OBSERVATION", rep, CSU_C09_STUDY_OBSERVATION.class);
116 return retVal;
117 }
118
119 /**
120 * Returns the number of existing repetitions of STUDY_OBSERVATION
121 */
122 public int getSTUDY_OBSERVATIONReps() {
123 return getReps("STUDY_OBSERVATION");
124 }
125
126 /**
127 * <p>
128 * Returns a non-modifiable List containing all current existing repetitions of STUDY_OBSERVATION.
129 * <p>
130 * <p>
131 * Note that unlike {@link #getSTUDY_OBSERVATION()}, this method will not create any reps
132 * if none are already present, so an empty list may be returned.
133 * </p>
134 */
135 public java.util.List<CSU_C09_STUDY_OBSERVATION> getSTUDY_OBSERVATIONAll() throws HL7Exception {
136 return getAllAsList("STUDY_OBSERVATION", CSU_C09_STUDY_OBSERVATION.class);
137 }
138
139 /**
140 * Inserts a specific repetition of STUDY_OBSERVATION (a Group object)
141 * @see AbstractGroup#insertRepetition(Structure, int)
142 */
143 public void insertSTUDY_OBSERVATION(CSU_C09_STUDY_OBSERVATION structure, int rep) throws HL7Exception {
144 super.insertRepetition("STUDY_OBSERVATION", structure, rep);
145 }
146
147
148 /**
149 * Inserts a specific repetition of STUDY_OBSERVATION (a Group object)
150 * @see AbstractGroup#insertRepetition(Structure, int)
151 */
152 public CSU_C09_STUDY_OBSERVATION insertSTUDY_OBSERVATION(int rep) throws HL7Exception {
153 return (CSU_C09_STUDY_OBSERVATION)super.insertRepetition("STUDY_OBSERVATION", rep);
154 }
155
156
157 /**
158 * Removes a specific repetition of STUDY_OBSERVATION (a Group object)
159 * @see AbstractGroup#removeRepetition(String, int)
160 */
161 public CSU_C09_STUDY_OBSERVATION removeSTUDY_OBSERVATION(int rep) throws HL7Exception {
162 return (CSU_C09_STUDY_OBSERVATION)super.removeRepetition("STUDY_OBSERVATION", rep);
163 }
164
165
166
167 /**
168 * Returns
169 * the first repetition of
170 * STUDY_PHARM (a Group object) - creates it if necessary
171 */
172 public CSU_C09_STUDY_PHARM getSTUDY_PHARM() {
173 CSU_C09_STUDY_PHARM retVal = getTyped("STUDY_PHARM", CSU_C09_STUDY_PHARM.class);
174 return retVal;
175 }
176
177
178 /**
179 * Returns a specific repetition of
180 * STUDY_PHARM (a Group object) - creates it if necessary
181 *
182 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
183 * @throws HL7Exception if the repetition requested is more than one
184 * greater than the number of existing repetitions.
185 */
186 public CSU_C09_STUDY_PHARM getSTUDY_PHARM(int rep) {
187 CSU_C09_STUDY_PHARM retVal = getTyped("STUDY_PHARM", rep, CSU_C09_STUDY_PHARM.class);
188 return retVal;
189 }
190
191 /**
192 * Returns the number of existing repetitions of STUDY_PHARM
193 */
194 public int getSTUDY_PHARMReps() {
195 return getReps("STUDY_PHARM");
196 }
197
198 /**
199 * <p>
200 * Returns a non-modifiable List containing all current existing repetitions of STUDY_PHARM.
201 * <p>
202 * <p>
203 * Note that unlike {@link #getSTUDY_PHARM()}, this method will not create any reps
204 * if none are already present, so an empty list may be returned.
205 * </p>
206 */
207 public java.util.List<CSU_C09_STUDY_PHARM> getSTUDY_PHARMAll() throws HL7Exception {
208 return getAllAsList("STUDY_PHARM", CSU_C09_STUDY_PHARM.class);
209 }
210
211 /**
212 * Inserts a specific repetition of STUDY_PHARM (a Group object)
213 * @see AbstractGroup#insertRepetition(Structure, int)
214 */
215 public void insertSTUDY_PHARM(CSU_C09_STUDY_PHARM structure, int rep) throws HL7Exception {
216 super.insertRepetition("STUDY_PHARM", structure, rep);
217 }
218
219
220 /**
221 * Inserts a specific repetition of STUDY_PHARM (a Group object)
222 * @see AbstractGroup#insertRepetition(Structure, int)
223 */
224 public CSU_C09_STUDY_PHARM insertSTUDY_PHARM(int rep) throws HL7Exception {
225 return (CSU_C09_STUDY_PHARM)super.insertRepetition("STUDY_PHARM", rep);
226 }
227
228
229 /**
230 * Removes a specific repetition of STUDY_PHARM (a Group object)
231 * @see AbstractGroup#removeRepetition(String, int)
232 */
233 public CSU_C09_STUDY_PHARM removeSTUDY_PHARM(int rep) throws HL7Exception {
234 return (CSU_C09_STUDY_PHARM)super.removeRepetition("STUDY_PHARM", rep);
235 }
236
237
238
239 }
240