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