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 RAS_O17_ORDER 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: ORC (Common Order) <b> </b></li>
49 * <li>2: RAS_O17_TIMING (a Group object) <b>optional repeating </b></li>
50 * <li>3: RAS_O17_ORDER_DETAIL (a Group object) <b>optional </b></li>
51 * <li>4: PRT (Participation Information) <b>optional repeating </b></li>
52 * <li>5: RAS_O17_ENCODING (a Group object) <b>optional </b></li>
53 * <li>6: RAS_O17_ADMINISTRATION (a Group object) <b> repeating </b></li>
54 * <li>7: CTI (Clinical Trial Identification) <b>optional repeating </b></li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class RAS_O17_ORDER extends AbstractGroup {
59
60 /**
61 * Creates a new RAS_O17_ORDER group
62 */
63 public RAS_O17_ORDER(Group parent, ModelClassFactory factory) {
64 super(parent, factory);
65 init(factory);
66 }
67
68 private void init(ModelClassFactory factory) {
69 try {
70 this.add(ORC.class, true, false, false);
71 this.add(RAS_O17_TIMING.class, false, true, false);
72 this.add(RAS_O17_ORDER_DETAIL.class, false, false, false);
73 this.add(PRT.class, false, true, false);
74 this.add(RAS_O17_ENCODING.class, false, false, false);
75 this.add(RAS_O17_ADMINISTRATION.class, true, true, false);
76 this.add(CTI.class, false, true, false);
77 } catch(HL7Exception e) {
78 log.error("Unexpected error creating RAS_O17_ORDER - this is probably a bug in the source code generator.", e);
79 }
80 }
81
82 /**
83 * Returns "2.7"
84 */
85 public String getVersion() {
86 return "2.7";
87 }
88
89
90
91 /**
92 * Returns
93 * ORC (Common Order) - creates it if necessary
94 */
95 public ORC getORC() {
96 ORC retVal = getTyped("ORC", ORC.class);
97 return retVal;
98 }
99
100
101
102
103 /**
104 * Returns
105 * the first repetition of
106 * TIMING (a Group object) - creates it if necessary
107 */
108 public RAS_O17_TIMING getTIMING() {
109 RAS_O17_TIMING retVal = getTyped("TIMING", RAS_O17_TIMING.class);
110 return retVal;
111 }
112
113
114 /**
115 * Returns a specific repetition of
116 * TIMING (a Group object) - creates it if necessary
117 *
118 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
119 * @throws HL7Exception if the repetition requested is more than one
120 * greater than the number of existing repetitions.
121 */
122 public RAS_O17_TIMING getTIMING(int rep) {
123 RAS_O17_TIMING retVal = getTyped("TIMING", rep, RAS_O17_TIMING.class);
124 return retVal;
125 }
126
127 /**
128 * Returns the number of existing repetitions of TIMING
129 */
130 public int getTIMINGReps() {
131 return getReps("TIMING");
132 }
133
134 /**
135 * <p>
136 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
137 * <p>
138 * <p>
139 * Note that unlike {@link #getTIMING()}, this method will not create any reps
140 * if none are already present, so an empty list may be returned.
141 * </p>
142 */
143 public java.util.List<RAS_O17_TIMING> getTIMINGAll() throws HL7Exception {
144 return getAllAsList("TIMING", RAS_O17_TIMING.class);
145 }
146
147 /**
148 * Inserts a specific repetition of TIMING (a Group object)
149 * @see AbstractGroup#insertRepetition(Structure, int)
150 */
151 public void insertTIMING(RAS_O17_TIMING structure, int rep) throws HL7Exception {
152 super.insertRepetition("TIMING", structure, rep);
153 }
154
155
156 /**
157 * Inserts a specific repetition of TIMING (a Group object)
158 * @see AbstractGroup#insertRepetition(Structure, int)
159 */
160 public RAS_O17_TIMING insertTIMING(int rep) throws HL7Exception {
161 return (RAS_O17_TIMING)super.insertRepetition("TIMING", rep);
162 }
163
164
165 /**
166 * Removes a specific repetition of TIMING (a Group object)
167 * @see AbstractGroup#removeRepetition(String, int)
168 */
169 public RAS_O17_TIMING removeTIMING(int rep) throws HL7Exception {
170 return (RAS_O17_TIMING)super.removeRepetition("TIMING", rep);
171 }
172
173
174
175 /**
176 * Returns
177 * ORDER_DETAIL (a Group object) - creates it if necessary
178 */
179 public RAS_O17_ORDER_DETAIL getORDER_DETAIL() {
180 RAS_O17_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RAS_O17_ORDER_DETAIL.class);
181 return retVal;
182 }
183
184
185
186
187 /**
188 * Returns
189 * the first repetition of
190 * PRT (Participation Information) - creates it if necessary
191 */
192 public PRT getPRT() {
193 PRT retVal = getTyped("PRT", PRT.class);
194 return retVal;
195 }
196
197
198 /**
199 * Returns a specific repetition of
200 * PRT (Participation Information) - creates it if necessary
201 *
202 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
203 * @throws HL7Exception if the repetition requested is more than one
204 * greater than the number of existing repetitions.
205 */
206 public PRT getPRT(int rep) {
207 PRT retVal = getTyped("PRT", rep, PRT.class);
208 return retVal;
209 }
210
211 /**
212 * Returns the number of existing repetitions of PRT
213 */
214 public int getPRTReps() {
215 return getReps("PRT");
216 }
217
218 /**
219 * <p>
220 * Returns a non-modifiable List containing all current existing repetitions of PRT.
221 * <p>
222 * <p>
223 * Note that unlike {@link #getPRT()}, this method will not create any reps
224 * if none are already present, so an empty list may be returned.
225 * </p>
226 */
227 public java.util.List<PRT> getPRTAll() throws HL7Exception {
228 return getAllAsList("PRT", PRT.class);
229 }
230
231 /**
232 * Inserts a specific repetition of PRT (Participation Information)
233 * @see AbstractGroup#insertRepetition(Structure, int)
234 */
235 public void insertPRT(PRT structure, int rep) throws HL7Exception {
236 super.insertRepetition("PRT", structure, rep);
237 }
238
239
240 /**
241 * Inserts a specific repetition of PRT (Participation Information)
242 * @see AbstractGroup#insertRepetition(Structure, int)
243 */
244 public PRT insertPRT(int rep) throws HL7Exception {
245 return (PRT)super.insertRepetition("PRT", rep);
246 }
247
248
249 /**
250 * Removes a specific repetition of PRT (Participation Information)
251 * @see AbstractGroup#removeRepetition(String, int)
252 */
253 public PRT removePRT(int rep) throws HL7Exception {
254 return (PRT)super.removeRepetition("PRT", rep);
255 }
256
257
258
259 /**
260 * Returns
261 * ENCODING (a Group object) - creates it if necessary
262 */
263 public RAS_O17_ENCODING getENCODING() {
264 RAS_O17_ENCODING retVal = getTyped("ENCODING", RAS_O17_ENCODING.class);
265 return retVal;
266 }
267
268
269
270
271 /**
272 * Returns
273 * the first repetition of
274 * ADMINISTRATION (a Group object) - creates it if necessary
275 */
276 public RAS_O17_ADMINISTRATION getADMINISTRATION() {
277 RAS_O17_ADMINISTRATION retVal = getTyped("ADMINISTRATION", RAS_O17_ADMINISTRATION.class);
278 return retVal;
279 }
280
281
282 /**
283 * Returns a specific repetition of
284 * ADMINISTRATION (a Group object) - creates it if necessary
285 *
286 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
287 * @throws HL7Exception if the repetition requested is more than one
288 * greater than the number of existing repetitions.
289 */
290 public RAS_O17_ADMINISTRATION getADMINISTRATION(int rep) {
291 RAS_O17_ADMINISTRATION retVal = getTyped("ADMINISTRATION", rep, RAS_O17_ADMINISTRATION.class);
292 return retVal;
293 }
294
295 /**
296 * Returns the number of existing repetitions of ADMINISTRATION
297 */
298 public int getADMINISTRATIONReps() {
299 return getReps("ADMINISTRATION");
300 }
301
302 /**
303 * <p>
304 * Returns a non-modifiable List containing all current existing repetitions of ADMINISTRATION.
305 * <p>
306 * <p>
307 * Note that unlike {@link #getADMINISTRATION()}, this method will not create any reps
308 * if none are already present, so an empty list may be returned.
309 * </p>
310 */
311 public java.util.List<RAS_O17_ADMINISTRATION> getADMINISTRATIONAll() throws HL7Exception {
312 return getAllAsList("ADMINISTRATION", RAS_O17_ADMINISTRATION.class);
313 }
314
315 /**
316 * Inserts a specific repetition of ADMINISTRATION (a Group object)
317 * @see AbstractGroup#insertRepetition(Structure, int)
318 */
319 public void insertADMINISTRATION(RAS_O17_ADMINISTRATION structure, int rep) throws HL7Exception {
320 super.insertRepetition("ADMINISTRATION", structure, rep);
321 }
322
323
324 /**
325 * Inserts a specific repetition of ADMINISTRATION (a Group object)
326 * @see AbstractGroup#insertRepetition(Structure, int)
327 */
328 public RAS_O17_ADMINISTRATION insertADMINISTRATION(int rep) throws HL7Exception {
329 return (RAS_O17_ADMINISTRATION)super.insertRepetition("ADMINISTRATION", rep);
330 }
331
332
333 /**
334 * Removes a specific repetition of ADMINISTRATION (a Group object)
335 * @see AbstractGroup#removeRepetition(String, int)
336 */
337 public RAS_O17_ADMINISTRATION removeADMINISTRATION(int rep) throws HL7Exception {
338 return (RAS_O17_ADMINISTRATION)super.removeRepetition("ADMINISTRATION", rep);
339 }
340
341
342
343 /**
344 * Returns
345 * the first repetition of
346 * CTI (Clinical Trial Identification) - creates it if necessary
347 */
348 public CTI getCTI() {
349 CTI retVal = getTyped("CTI", CTI.class);
350 return retVal;
351 }
352
353
354 /**
355 * Returns a specific repetition of
356 * CTI (Clinical Trial Identification) - creates it if necessary
357 *
358 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
359 * @throws HL7Exception if the repetition requested is more than one
360 * greater than the number of existing repetitions.
361 */
362 public CTI getCTI(int rep) {
363 CTI retVal = getTyped("CTI", rep, CTI.class);
364 return retVal;
365 }
366
367 /**
368 * Returns the number of existing repetitions of CTI
369 */
370 public int getCTIReps() {
371 return getReps("CTI");
372 }
373
374 /**
375 * <p>
376 * Returns a non-modifiable List containing all current existing repetitions of CTI.
377 * <p>
378 * <p>
379 * Note that unlike {@link #getCTI()}, this method will not create any reps
380 * if none are already present, so an empty list may be returned.
381 * </p>
382 */
383 public java.util.List<CTI> getCTIAll() throws HL7Exception {
384 return getAllAsList("CTI", CTI.class);
385 }
386
387 /**
388 * Inserts a specific repetition of CTI (Clinical Trial Identification)
389 * @see AbstractGroup#insertRepetition(Structure, int)
390 */
391 public void insertCTI(CTI structure, int rep) throws HL7Exception {
392 super.insertRepetition("CTI", structure, rep);
393 }
394
395
396 /**
397 * Inserts a specific repetition of CTI (Clinical Trial Identification)
398 * @see AbstractGroup#insertRepetition(Structure, int)
399 */
400 public CTI insertCTI(int rep) throws HL7Exception {
401 return (CTI)super.insertRepetition("CTI", rep);
402 }
403
404
405 /**
406 * Removes a specific repetition of CTI (Clinical Trial Identification)
407 * @see AbstractGroup#removeRepetition(String, int)
408 */
409 public CTI removeCTI(int rep) throws HL7Exception {
410 return (CTI)super.removeRepetition("CTI", rep);
411 }
412
413
414
415 }
416