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.v231.group;
35
36 import ca.uhn.hl7v2.model.v231.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 PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR 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: GOL (Goal Detail) <b> </b></li>
49 * <li>2: NTE (NTE - notes and comments segment) <b>optional repeating </b></li>
50 * <li>3: VAR (Variance) <b>optional repeating </b></li>
51 * <li>4: PGL_PC6_ROLVAR (a Group object) <b>optional repeating </b></li>
52 * <li>5: PGL_PC6_PTHVAR (a Group object) <b>optional repeating </b></li>
53 * <li>6: PGL_PC6_OBXNTE (a Group object) <b>optional repeating </b></li>
54 * <li>7: PGL_PC6_PRBNTEVARROLVAROBXNTE (a Group object) <b>optional repeating </b></li>
55 * <li>8: PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR (a Group object) <b>optional repeating </b></li>
56 * </ul>
57 */
58 //@SuppressWarnings("unused")
59 public class PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR extends AbstractGroup {
60
61 /**
62 * Creates a new PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR group
63 */
64 public PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR(Group parent, ModelClassFactory factory) {
65 super(parent, factory);
66 init(factory);
67 }
68
69 private void init(ModelClassFactory factory) {
70 try {
71 this.add(GOL.class, true, false, false);
72 this.add(NTE.class, false, true, false);
73 this.add(VAR.class, false, true, false);
74 this.add(PGL_PC6_ROLVAR.class, false, true, false);
75 this.add(PGL_PC6_PTHVAR.class, false, true, false);
76 this.add(PGL_PC6_OBXNTE.class, false, true, false);
77 this.add(PGL_PC6_PRBNTEVARROLVAROBXNTE.class, false, true, false);
78 this.add(PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR.class, false, true, false);
79 } catch(HL7Exception e) {
80 log.error("Unexpected error creating PGL_PC6_GOLNTEVARROLVARPTHVAROBXNTEPRBNTEVARROLVAROBXNTEORCOBRRXONTEVAROBXNTEVAR - this is probably a bug in the source code generator.", e);
81 }
82 }
83
84 /**
85 * Returns "2.3.1"
86 */
87 public String getVersion() {
88 return "2.3.1";
89 }
90
91
92
93 /**
94 * Returns
95 * GOL (Goal Detail) - creates it if necessary
96 */
97 public GOL getGOL() {
98 GOL retVal = getTyped("GOL", GOL.class);
99 return retVal;
100 }
101
102
103
104
105 /**
106 * Returns
107 * the first repetition of
108 * NTE (NTE - notes and comments segment) - creates it if necessary
109 */
110 public NTE getNTE() {
111 NTE retVal = getTyped("NTE", NTE.class);
112 return retVal;
113 }
114
115
116 /**
117 * Returns a specific repetition of
118 * NTE (NTE - notes and comments segment) - creates it if necessary
119 *
120 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
121 * @throws HL7Exception if the repetition requested is more than one
122 * greater than the number of existing repetitions.
123 */
124 public NTE getNTE(int rep) {
125 NTE retVal = getTyped("NTE", rep, NTE.class);
126 return retVal;
127 }
128
129 /**
130 * Returns the number of existing repetitions of NTE
131 */
132 public int getNTEReps() {
133 return getReps("NTE");
134 }
135
136 /**
137 * <p>
138 * Returns a non-modifiable List containing all current existing repetitions of NTE.
139 * <p>
140 * <p>
141 * Note that unlike {@link #getNTE()}, this method will not create any reps
142 * if none are already present, so an empty list may be returned.
143 * </p>
144 */
145 public java.util.List<NTE> getNTEAll() throws HL7Exception {
146 return getAllAsList("NTE", NTE.class);
147 }
148
149 /**
150 * Inserts a specific repetition of NTE (NTE - notes and comments segment)
151 * @see AbstractGroup#insertRepetition(Structure, int)
152 */
153 public void insertNTE(NTE structure, int rep) throws HL7Exception {
154 super.insertRepetition("NTE", structure, rep);
155 }
156
157
158 /**
159 * Inserts a specific repetition of NTE (NTE - notes and comments segment)
160 * @see AbstractGroup#insertRepetition(Structure, int)
161 */
162 public NTE insertNTE(int rep) throws HL7Exception {
163 return (NTE)super.insertRepetition("NTE", rep);
164 }
165
166
167 /**
168 * Removes a specific repetition of NTE (NTE - notes and comments segment)
169 * @see AbstractGroup#removeRepetition(String, int)
170 */
171 public NTE removeNTE(int rep) throws HL7Exception {
172 return (NTE)super.removeRepetition("NTE", rep);
173 }
174
175
176
177 /**
178 * Returns
179 * the first repetition of
180 * VAR (Variance) - creates it if necessary
181 */
182 public VAR getVAR() {
183 VAR retVal = getTyped("VAR", VAR.class);
184 return retVal;
185 }
186
187
188 /**
189 * Returns a specific repetition of
190 * VAR (Variance) - creates it if necessary
191 *
192 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
193 * @throws HL7Exception if the repetition requested is more than one
194 * greater than the number of existing repetitions.
195 */
196 public VAR getVAR(int rep) {
197 VAR retVal = getTyped("VAR", rep, VAR.class);
198 return retVal;
199 }
200
201 /**
202 * Returns the number of existing repetitions of VAR
203 */
204 public int getVARReps() {
205 return getReps("VAR");
206 }
207
208 /**
209 * <p>
210 * Returns a non-modifiable List containing all current existing repetitions of VAR.
211 * <p>
212 * <p>
213 * Note that unlike {@link #getVAR()}, this method will not create any reps
214 * if none are already present, so an empty list may be returned.
215 * </p>
216 */
217 public java.util.List<VAR> getVARAll() throws HL7Exception {
218 return getAllAsList("VAR", VAR.class);
219 }
220
221 /**
222 * Inserts a specific repetition of VAR (Variance)
223 * @see AbstractGroup#insertRepetition(Structure, int)
224 */
225 public void insertVAR(VAR structure, int rep) throws HL7Exception {
226 super.insertRepetition("VAR", structure, rep);
227 }
228
229
230 /**
231 * Inserts a specific repetition of VAR (Variance)
232 * @see AbstractGroup#insertRepetition(Structure, int)
233 */
234 public VAR insertVAR(int rep) throws HL7Exception {
235 return (VAR)super.insertRepetition("VAR", rep);
236 }
237
238
239 /**
240 * Removes a specific repetition of VAR (Variance)
241 * @see AbstractGroup#removeRepetition(String, int)
242 */
243 public VAR removeVAR(int rep) throws HL7Exception {
244 return (VAR)super.removeRepetition("VAR", rep);
245 }
246
247
248
249 /**
250 * Returns
251 * the first repetition of
252 * ROLVAR (a Group object) - creates it if necessary
253 */
254 public PGL_PC6_ROLVAR getROLVAR() {
255 PGL_PC6_ROLVAR retVal = getTyped("ROLVAR", PGL_PC6_ROLVAR.class);
256 return retVal;
257 }
258
259
260 /**
261 * Returns a specific repetition of
262 * ROLVAR (a Group object) - creates it if necessary
263 *
264 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
265 * @throws HL7Exception if the repetition requested is more than one
266 * greater than the number of existing repetitions.
267 */
268 public PGL_PC6_ROLVAR getROLVAR(int rep) {
269 PGL_PC6_ROLVAR retVal = getTyped("ROLVAR", rep, PGL_PC6_ROLVAR.class);
270 return retVal;
271 }
272
273 /**
274 * Returns the number of existing repetitions of ROLVAR
275 */
276 public int getROLVARReps() {
277 return getReps("ROLVAR");
278 }
279
280 /**
281 * <p>
282 * Returns a non-modifiable List containing all current existing repetitions of ROLVAR.
283 * <p>
284 * <p>
285 * Note that unlike {@link #getROLVAR()}, this method will not create any reps
286 * if none are already present, so an empty list may be returned.
287 * </p>
288 */
289 public java.util.List<PGL_PC6_ROLVAR> getROLVARAll() throws HL7Exception {
290 return getAllAsList("ROLVAR", PGL_PC6_ROLVAR.class);
291 }
292
293 /**
294 * Inserts a specific repetition of ROLVAR (a Group object)
295 * @see AbstractGroup#insertRepetition(Structure, int)
296 */
297 public void insertROLVAR(PGL_PC6_ROLVAR structure, int rep) throws HL7Exception {
298 super.insertRepetition("ROLVAR", structure, rep);
299 }
300
301
302 /**
303 * Inserts a specific repetition of ROLVAR (a Group object)
304 * @see AbstractGroup#insertRepetition(Structure, int)
305 */
306 public PGL_PC6_ROLVAR insertROLVAR(int rep) throws HL7Exception {
307 return (PGL_PC6_ROLVAR)super.insertRepetition("ROLVAR", rep);
308 }
309
310
311 /**
312 * Removes a specific repetition of ROLVAR (a Group object)
313 * @see AbstractGroup#removeRepetition(String, int)
314 */
315 public PGL_PC6_ROLVAR removeROLVAR(int rep) throws HL7Exception {
316 return (PGL_PC6_ROLVAR)super.removeRepetition("ROLVAR", rep);
317 }
318
319
320
321 /**
322 * Returns
323 * the first repetition of
324 * PTHVAR (a Group object) - creates it if necessary
325 */
326 public PGL_PC6_PTHVAR getPTHVAR() {
327 PGL_PC6_PTHVAR retVal = getTyped("PTHVAR", PGL_PC6_PTHVAR.class);
328 return retVal;
329 }
330
331
332 /**
333 * Returns a specific repetition of
334 * PTHVAR (a Group object) - creates it if necessary
335 *
336 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
337 * @throws HL7Exception if the repetition requested is more than one
338 * greater than the number of existing repetitions.
339 */
340 public PGL_PC6_PTHVAR getPTHVAR(int rep) {
341 PGL_PC6_PTHVAR retVal = getTyped("PTHVAR", rep, PGL_PC6_PTHVAR.class);
342 return retVal;
343 }
344
345 /**
346 * Returns the number of existing repetitions of PTHVAR
347 */
348 public int getPTHVARReps() {
349 return getReps("PTHVAR");
350 }
351
352 /**
353 * <p>
354 * Returns a non-modifiable List containing all current existing repetitions of PTHVAR.
355 * <p>
356 * <p>
357 * Note that unlike {@link #getPTHVAR()}, this method will not create any reps
358 * if none are already present, so an empty list may be returned.
359 * </p>
360 */
361 public java.util.List<PGL_PC6_PTHVAR> getPTHVARAll() throws HL7Exception {
362 return getAllAsList("PTHVAR", PGL_PC6_PTHVAR.class);
363 }
364
365 /**
366 * Inserts a specific repetition of PTHVAR (a Group object)
367 * @see AbstractGroup#insertRepetition(Structure, int)
368 */
369 public void insertPTHVAR(PGL_PC6_PTHVAR structure, int rep) throws HL7Exception {
370 super.insertRepetition("PTHVAR", structure, rep);
371 }
372
373
374 /**
375 * Inserts a specific repetition of PTHVAR (a Group object)
376 * @see AbstractGroup#insertRepetition(Structure, int)
377 */
378 public PGL_PC6_PTHVAR insertPTHVAR(int rep) throws HL7Exception {
379 return (PGL_PC6_PTHVAR)super.insertRepetition("PTHVAR", rep);
380 }
381
382
383 /**
384 * Removes a specific repetition of PTHVAR (a Group object)
385 * @see AbstractGroup#removeRepetition(String, int)
386 */
387 public PGL_PC6_PTHVAR removePTHVAR(int rep) throws HL7Exception {
388 return (PGL_PC6_PTHVAR)super.removeRepetition("PTHVAR", rep);
389 }
390
391
392
393 /**
394 * Returns
395 * the first repetition of
396 * OBXNTE (a Group object) - creates it if necessary
397 */
398 public PGL_PC6_OBXNTE getOBXNTE() {
399 PGL_PC6_OBXNTE retVal = getTyped("OBXNTE", PGL_PC6_OBXNTE.class);
400 return retVal;
401 }
402
403
404 /**
405 * Returns a specific repetition of
406 * OBXNTE (a Group object) - creates it if necessary
407 *
408 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
409 * @throws HL7Exception if the repetition requested is more than one
410 * greater than the number of existing repetitions.
411 */
412 public PGL_PC6_OBXNTE getOBXNTE(int rep) {
413 PGL_PC6_OBXNTE retVal = getTyped("OBXNTE", rep, PGL_PC6_OBXNTE.class);
414 return retVal;
415 }
416
417 /**
418 * Returns the number of existing repetitions of OBXNTE
419 */
420 public int getOBXNTEReps() {
421 return getReps("OBXNTE");
422 }
423
424 /**
425 * <p>
426 * Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
427 * <p>
428 * <p>
429 * Note that unlike {@link #getOBXNTE()}, this method will not create any reps
430 * if none are already present, so an empty list may be returned.
431 * </p>
432 */
433 public java.util.List<PGL_PC6_OBXNTE> getOBXNTEAll() throws HL7Exception {
434 return getAllAsList("OBXNTE", PGL_PC6_OBXNTE.class);
435 }
436
437 /**
438 * Inserts a specific repetition of OBXNTE (a Group object)
439 * @see AbstractGroup#insertRepetition(Structure, int)
440 */
441 public void insertOBXNTE(PGL_PC6_OBXNTE structure, int rep) throws HL7Exception {
442 super.insertRepetition("OBXNTE", structure, rep);
443 }
444
445
446 /**
447 * Inserts a specific repetition of OBXNTE (a Group object)
448 * @see AbstractGroup#insertRepetition(Structure, int)
449 */
450 public PGL_PC6_OBXNTE insertOBXNTE(int rep) throws HL7Exception {
451 return (PGL_PC6_OBXNTE)super.insertRepetition("OBXNTE", rep);
452 }
453
454
455 /**
456 * Removes a specific repetition of OBXNTE (a Group object)
457 * @see AbstractGroup#removeRepetition(String, int)
458 */
459 public PGL_PC6_OBXNTE removeOBXNTE(int rep) throws HL7Exception {
460 return (PGL_PC6_OBXNTE)super.removeRepetition("OBXNTE", rep);
461 }
462
463
464
465 /**
466 * Returns
467 * the first repetition of
468 * PRBNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
469 */
470 public PGL_PC6_PRBNTEVARROLVAROBXNTE getPRBNTEVARROLVAROBXNTE() {
471 PGL_PC6_PRBNTEVARROLVAROBXNTE retVal = getTyped("PRBNTEVARROLVAROBXNTE", PGL_PC6_PRBNTEVARROLVAROBXNTE.class);
472 return retVal;
473 }
474
475
476 /**
477 * Returns a specific repetition of
478 * PRBNTEVARROLVAROBXNTE (a Group object) - creates it if necessary
479 *
480 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
481 * @throws HL7Exception if the repetition requested is more than one
482 * greater than the number of existing repetitions.
483 */
484 public PGL_PC6_PRBNTEVARROLVAROBXNTE getPRBNTEVARROLVAROBXNTE(int rep) {
485 PGL_PC6_PRBNTEVARROLVAROBXNTE retVal = getTyped("PRBNTEVARROLVAROBXNTE", rep, PGL_PC6_PRBNTEVARROLVAROBXNTE.class);
486 return retVal;
487 }
488
489 /**
490 * Returns the number of existing repetitions of PRBNTEVARROLVAROBXNTE
491 */
492 public int getPRBNTEVARROLVAROBXNTEReps() {
493 return getReps("PRBNTEVARROLVAROBXNTE");
494 }
495
496 /**
497 * <p>
498 * Returns a non-modifiable List containing all current existing repetitions of PRBNTEVARROLVAROBXNTE.
499 * <p>
500 * <p>
501 * Note that unlike {@link #getPRBNTEVARROLVAROBXNTE()}, this method will not create any reps
502 * if none are already present, so an empty list may be returned.
503 * </p>
504 */
505 public java.util.List<PGL_PC6_PRBNTEVARROLVAROBXNTE> getPRBNTEVARROLVAROBXNTEAll() throws HL7Exception {
506 return getAllAsList("PRBNTEVARROLVAROBXNTE", PGL_PC6_PRBNTEVARROLVAROBXNTE.class);
507 }
508
509 /**
510 * Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)
511 * @see AbstractGroup#insertRepetition(Structure, int)
512 */
513 public void insertPRBNTEVARROLVAROBXNTE(PGL_PC6_PRBNTEVARROLVAROBXNTE structure, int rep) throws HL7Exception {
514 super.insertRepetition("PRBNTEVARROLVAROBXNTE", structure, rep);
515 }
516
517
518 /**
519 * Inserts a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)
520 * @see AbstractGroup#insertRepetition(Structure, int)
521 */
522 public PGL_PC6_PRBNTEVARROLVAROBXNTE insertPRBNTEVARROLVAROBXNTE(int rep) throws HL7Exception {
523 return (PGL_PC6_PRBNTEVARROLVAROBXNTE)super.insertRepetition("PRBNTEVARROLVAROBXNTE", rep);
524 }
525
526
527 /**
528 * Removes a specific repetition of PRBNTEVARROLVAROBXNTE (a Group object)
529 * @see AbstractGroup#removeRepetition(String, int)
530 */
531 public PGL_PC6_PRBNTEVARROLVAROBXNTE removePRBNTEVARROLVAROBXNTE(int rep) throws HL7Exception {
532 return (PGL_PC6_PRBNTEVARROLVAROBXNTE)super.removeRepetition("PRBNTEVARROLVAROBXNTE", rep);
533 }
534
535
536
537 /**
538 * Returns
539 * the first repetition of
540 * ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
541 */
542 public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR() {
543 PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR retVal = getTyped("ORCOBRRXONTEVAROBXNTEVAR", PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR.class);
544 return retVal;
545 }
546
547
548 /**
549 * Returns a specific repetition of
550 * ORCOBRRXONTEVAROBXNTEVAR (a Group object) - creates it if necessary
551 *
552 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
553 * @throws HL7Exception if the repetition requested is more than one
554 * greater than the number of existing repetitions.
555 */
556 public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR getORCOBRRXONTEVAROBXNTEVAR(int rep) {
557 PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR retVal = getTyped("ORCOBRRXONTEVAROBXNTEVAR", rep, PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR.class);
558 return retVal;
559 }
560
561 /**
562 * Returns the number of existing repetitions of ORCOBRRXONTEVAROBXNTEVAR
563 */
564 public int getORCOBRRXONTEVAROBXNTEVARReps() {
565 return getReps("ORCOBRRXONTEVAROBXNTEVAR");
566 }
567
568 /**
569 * <p>
570 * Returns a non-modifiable List containing all current existing repetitions of ORCOBRRXONTEVAROBXNTEVAR.
571 * <p>
572 * <p>
573 * Note that unlike {@link #getORCOBRRXONTEVAROBXNTEVAR()}, this method will not create any reps
574 * if none are already present, so an empty list may be returned.
575 * </p>
576 */
577 public java.util.List<PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR> getORCOBRRXONTEVAROBXNTEVARAll() throws HL7Exception {
578 return getAllAsList("ORCOBRRXONTEVAROBXNTEVAR", PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR.class);
579 }
580
581 /**
582 * Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
583 * @see AbstractGroup#insertRepetition(Structure, int)
584 */
585 public void insertORCOBRRXONTEVAROBXNTEVAR(PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR structure, int rep) throws HL7Exception {
586 super.insertRepetition("ORCOBRRXONTEVAROBXNTEVAR", structure, rep);
587 }
588
589
590 /**
591 * Inserts a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
592 * @see AbstractGroup#insertRepetition(Structure, int)
593 */
594 public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR insertORCOBRRXONTEVAROBXNTEVAR(int rep) throws HL7Exception {
595 return (PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR)super.insertRepetition("ORCOBRRXONTEVAROBXNTEVAR", rep);
596 }
597
598
599 /**
600 * Removes a specific repetition of ORCOBRRXONTEVAROBXNTEVAR (a Group object)
601 * @see AbstractGroup#removeRepetition(String, int)
602 */
603 public PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR removeORCOBRRXONTEVAROBXNTEVAR(int rep) throws HL7Exception {
604 return (PGL_PC6_ORCOBRRXONTEVAROBXNTEVAR)super.removeRepetition("ORCOBRRXONTEVAROBXNTEVAR", rep);
605 }
606
607
608
609 }
610