001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v25.group;
035
036import ca.uhn.hl7v2.model.v25.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a PPP_PCB_PROBLEM group structure (a Group object).
044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
045 * This Group contains the following elements:  
046 * </p>
047 * <ul>
048                         * <li>1: PRB (Problem Details) <b>  </b></li>
049                         * <li>2: NTE (Notes and Comments) <b>optional repeating </b></li>
050                         * <li>3: VAR (Variance) <b>optional repeating </b></li>
051                         * <li>4: PPP_PCB_PROBLEM_ROLE (a Group object) <b>optional repeating </b></li>
052                         * <li>5: PPP_PCB_PROBLEM_OBSERVATION (a Group object) <b>optional repeating </b></li>
053                         * <li>6: PPP_PCB_GOAL (a Group object) <b>optional repeating </b></li>
054                         * <li>7: PPP_PCB_ORDER (a Group object) <b>optional repeating </b></li>
055 * </ul>
056 */
057//@SuppressWarnings("unused")
058public class PPP_PCB_PROBLEM extends AbstractGroup {
059
060    /** 
061     * Creates a new PPP_PCB_PROBLEM group
062     */
063    public PPP_PCB_PROBLEM(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(PRB.class, true, false, false);
071                                  this.add(NTE.class, false, true, false);
072                                  this.add(VAR.class, false, true, false);
073                                  this.add(PPP_PCB_PROBLEM_ROLE.class, false, true, false);
074                                  this.add(PPP_PCB_PROBLEM_OBSERVATION.class, false, true, false);
075                                  this.add(PPP_PCB_GOAL.class, false, true, false);
076                                  this.add(PPP_PCB_ORDER.class, false, true, false);
077       } catch(HL7Exception e) {
078          log.error("Unexpected error creating PPP_PCB_PROBLEM - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082    /** 
083     * Returns "2.5"
084     */
085    public String getVersion() {
086       return "2.5";
087    }
088
089
090
091    /**
092     * Returns
093     * PRB (Problem Details) - creates it if necessary
094     */
095    public PRB getPRB() { 
096       PRB retVal = getTyped("PRB", PRB.class);
097       return retVal;
098    }
099
100
101
102
103    /**
104     * Returns
105     * the first repetition of 
106     * NTE (Notes and Comments) - creates it if necessary
107     */
108    public NTE getNTE() { 
109       NTE retVal = getTyped("NTE", NTE.class);
110       return retVal;
111    }
112
113
114    /**
115     * Returns a specific repetition of
116     * NTE (Notes and Comments) - 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 NTE getNTE(int rep) { 
123       NTE retVal = getTyped("NTE", rep, NTE.class);
124       return retVal;
125    }
126
127    /** 
128     * Returns the number of existing repetitions of NTE 
129     */ 
130    public int getNTEReps() {  
131        return getReps("NTE");
132    } 
133
134    /** 
135     * <p>
136     * Returns a non-modifiable List containing all current existing repetitions of NTE.
137     * <p>
138     * <p>
139     * Note that unlike {@link #getNTE()}, 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<NTE> getNTEAll() throws HL7Exception {
144        return getAllAsList("NTE", NTE.class);
145    } 
146
147    /**
148     * Inserts a specific repetition of NTE (Notes and Comments)
149     * @see AbstractGroup#insertRepetition(Structure, int) 
150     */
151    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
152       super.insertRepetition("NTE", structure, rep);
153    }
154
155
156    /**
157     * Inserts a specific repetition of NTE (Notes and Comments)
158     * @see AbstractGroup#insertRepetition(Structure, int) 
159     */
160    public NTE insertNTE(int rep) throws HL7Exception { 
161       return (NTE)super.insertRepetition("NTE", rep);
162    }
163
164
165    /**
166     * Removes a specific repetition of NTE (Notes and Comments)
167     * @see AbstractGroup#removeRepetition(String, int) 
168     */
169    public NTE removeNTE(int rep) throws HL7Exception { 
170       return (NTE)super.removeRepetition("NTE", rep);
171    }
172
173
174
175    /**
176     * Returns
177     * the first repetition of 
178     * VAR (Variance) - creates it if necessary
179     */
180    public VAR getVAR() { 
181       VAR retVal = getTyped("VAR", VAR.class);
182       return retVal;
183    }
184
185
186    /**
187     * Returns a specific repetition of
188     * VAR (Variance) - creates it if necessary
189     *
190     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
191     * @throws HL7Exception if the repetition requested is more than one 
192     *     greater than the number of existing repetitions.
193     */
194    public VAR getVAR(int rep) { 
195       VAR retVal = getTyped("VAR", rep, VAR.class);
196       return retVal;
197    }
198
199    /** 
200     * Returns the number of existing repetitions of VAR 
201     */ 
202    public int getVARReps() {  
203        return getReps("VAR");
204    } 
205
206    /** 
207     * <p>
208     * Returns a non-modifiable List containing all current existing repetitions of VAR.
209     * <p>
210     * <p>
211     * Note that unlike {@link #getVAR()}, this method will not create any reps
212     * if none are already present, so an empty list may be returned.
213     * </p>
214     */ 
215    public java.util.List<VAR> getVARAll() throws HL7Exception {
216        return getAllAsList("VAR", VAR.class);
217    } 
218
219    /**
220     * Inserts a specific repetition of VAR (Variance)
221     * @see AbstractGroup#insertRepetition(Structure, int) 
222     */
223    public void insertVAR(VAR structure, int rep) throws HL7Exception { 
224       super.insertRepetition("VAR", structure, rep);
225    }
226
227
228    /**
229     * Inserts a specific repetition of VAR (Variance)
230     * @see AbstractGroup#insertRepetition(Structure, int) 
231     */
232    public VAR insertVAR(int rep) throws HL7Exception { 
233       return (VAR)super.insertRepetition("VAR", rep);
234    }
235
236
237    /**
238     * Removes a specific repetition of VAR (Variance)
239     * @see AbstractGroup#removeRepetition(String, int) 
240     */
241    public VAR removeVAR(int rep) throws HL7Exception { 
242       return (VAR)super.removeRepetition("VAR", rep);
243    }
244
245
246
247    /**
248     * Returns
249     * the first repetition of 
250     * PROBLEM_ROLE (a Group object) - creates it if necessary
251     */
252    public PPP_PCB_PROBLEM_ROLE getPROBLEM_ROLE() { 
253       PPP_PCB_PROBLEM_ROLE retVal = getTyped("PROBLEM_ROLE", PPP_PCB_PROBLEM_ROLE.class);
254       return retVal;
255    }
256
257
258    /**
259     * Returns a specific repetition of
260     * PROBLEM_ROLE (a Group object) - creates it if necessary
261     *
262     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
263     * @throws HL7Exception if the repetition requested is more than one 
264     *     greater than the number of existing repetitions.
265     */
266    public PPP_PCB_PROBLEM_ROLE getPROBLEM_ROLE(int rep) { 
267       PPP_PCB_PROBLEM_ROLE retVal = getTyped("PROBLEM_ROLE", rep, PPP_PCB_PROBLEM_ROLE.class);
268       return retVal;
269    }
270
271    /** 
272     * Returns the number of existing repetitions of PROBLEM_ROLE 
273     */ 
274    public int getPROBLEM_ROLEReps() {  
275        return getReps("PROBLEM_ROLE");
276    } 
277
278    /** 
279     * <p>
280     * Returns a non-modifiable List containing all current existing repetitions of PROBLEM_ROLE.
281     * <p>
282     * <p>
283     * Note that unlike {@link #getPROBLEM_ROLE()}, this method will not create any reps
284     * if none are already present, so an empty list may be returned.
285     * </p>
286     */ 
287    public java.util.List<PPP_PCB_PROBLEM_ROLE> getPROBLEM_ROLEAll() throws HL7Exception {
288        return getAllAsList("PROBLEM_ROLE", PPP_PCB_PROBLEM_ROLE.class);
289    } 
290
291    /**
292     * Inserts a specific repetition of PROBLEM_ROLE (a Group object)
293     * @see AbstractGroup#insertRepetition(Structure, int) 
294     */
295    public void insertPROBLEM_ROLE(PPP_PCB_PROBLEM_ROLE structure, int rep) throws HL7Exception { 
296       super.insertRepetition("PROBLEM_ROLE", structure, rep);
297    }
298
299
300    /**
301     * Inserts a specific repetition of PROBLEM_ROLE (a Group object)
302     * @see AbstractGroup#insertRepetition(Structure, int) 
303     */
304    public PPP_PCB_PROBLEM_ROLE insertPROBLEM_ROLE(int rep) throws HL7Exception { 
305       return (PPP_PCB_PROBLEM_ROLE)super.insertRepetition("PROBLEM_ROLE", rep);
306    }
307
308
309    /**
310     * Removes a specific repetition of PROBLEM_ROLE (a Group object)
311     * @see AbstractGroup#removeRepetition(String, int) 
312     */
313    public PPP_PCB_PROBLEM_ROLE removePROBLEM_ROLE(int rep) throws HL7Exception { 
314       return (PPP_PCB_PROBLEM_ROLE)super.removeRepetition("PROBLEM_ROLE", rep);
315    }
316
317
318
319    /**
320     * Returns
321     * the first repetition of 
322     * PROBLEM_OBSERVATION (a Group object) - creates it if necessary
323     */
324    public PPP_PCB_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION() { 
325       PPP_PCB_PROBLEM_OBSERVATION retVal = getTyped("PROBLEM_OBSERVATION", PPP_PCB_PROBLEM_OBSERVATION.class);
326       return retVal;
327    }
328
329
330    /**
331     * Returns a specific repetition of
332     * PROBLEM_OBSERVATION (a Group object) - creates it if necessary
333     *
334     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
335     * @throws HL7Exception if the repetition requested is more than one 
336     *     greater than the number of existing repetitions.
337     */
338    public PPP_PCB_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION(int rep) { 
339       PPP_PCB_PROBLEM_OBSERVATION retVal = getTyped("PROBLEM_OBSERVATION", rep, PPP_PCB_PROBLEM_OBSERVATION.class);
340       return retVal;
341    }
342
343    /** 
344     * Returns the number of existing repetitions of PROBLEM_OBSERVATION 
345     */ 
346    public int getPROBLEM_OBSERVATIONReps() {  
347        return getReps("PROBLEM_OBSERVATION");
348    } 
349
350    /** 
351     * <p>
352     * Returns a non-modifiable List containing all current existing repetitions of PROBLEM_OBSERVATION.
353     * <p>
354     * <p>
355     * Note that unlike {@link #getPROBLEM_OBSERVATION()}, this method will not create any reps
356     * if none are already present, so an empty list may be returned.
357     * </p>
358     */ 
359    public java.util.List<PPP_PCB_PROBLEM_OBSERVATION> getPROBLEM_OBSERVATIONAll() throws HL7Exception {
360        return getAllAsList("PROBLEM_OBSERVATION", PPP_PCB_PROBLEM_OBSERVATION.class);
361    } 
362
363    /**
364     * Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
365     * @see AbstractGroup#insertRepetition(Structure, int) 
366     */
367    public void insertPROBLEM_OBSERVATION(PPP_PCB_PROBLEM_OBSERVATION structure, int rep) throws HL7Exception { 
368       super.insertRepetition("PROBLEM_OBSERVATION", structure, rep);
369    }
370
371
372    /**
373     * Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
374     * @see AbstractGroup#insertRepetition(Structure, int) 
375     */
376    public PPP_PCB_PROBLEM_OBSERVATION insertPROBLEM_OBSERVATION(int rep) throws HL7Exception { 
377       return (PPP_PCB_PROBLEM_OBSERVATION)super.insertRepetition("PROBLEM_OBSERVATION", rep);
378    }
379
380
381    /**
382     * Removes a specific repetition of PROBLEM_OBSERVATION (a Group object)
383     * @see AbstractGroup#removeRepetition(String, int) 
384     */
385    public PPP_PCB_PROBLEM_OBSERVATION removePROBLEM_OBSERVATION(int rep) throws HL7Exception { 
386       return (PPP_PCB_PROBLEM_OBSERVATION)super.removeRepetition("PROBLEM_OBSERVATION", rep);
387    }
388
389
390
391    /**
392     * Returns
393     * the first repetition of 
394     * GOAL (a Group object) - creates it if necessary
395     */
396    public PPP_PCB_GOAL getGOAL() { 
397       PPP_PCB_GOAL retVal = getTyped("GOAL", PPP_PCB_GOAL.class);
398       return retVal;
399    }
400
401
402    /**
403     * Returns a specific repetition of
404     * GOAL (a Group object) - creates it if necessary
405     *
406     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
407     * @throws HL7Exception if the repetition requested is more than one 
408     *     greater than the number of existing repetitions.
409     */
410    public PPP_PCB_GOAL getGOAL(int rep) { 
411       PPP_PCB_GOAL retVal = getTyped("GOAL", rep, PPP_PCB_GOAL.class);
412       return retVal;
413    }
414
415    /** 
416     * Returns the number of existing repetitions of GOAL 
417     */ 
418    public int getGOALReps() {  
419        return getReps("GOAL");
420    } 
421
422    /** 
423     * <p>
424     * Returns a non-modifiable List containing all current existing repetitions of GOAL.
425     * <p>
426     * <p>
427     * Note that unlike {@link #getGOAL()}, this method will not create any reps
428     * if none are already present, so an empty list may be returned.
429     * </p>
430     */ 
431    public java.util.List<PPP_PCB_GOAL> getGOALAll() throws HL7Exception {
432        return getAllAsList("GOAL", PPP_PCB_GOAL.class);
433    } 
434
435    /**
436     * Inserts a specific repetition of GOAL (a Group object)
437     * @see AbstractGroup#insertRepetition(Structure, int) 
438     */
439    public void insertGOAL(PPP_PCB_GOAL structure, int rep) throws HL7Exception { 
440       super.insertRepetition("GOAL", structure, rep);
441    }
442
443
444    /**
445     * Inserts a specific repetition of GOAL (a Group object)
446     * @see AbstractGroup#insertRepetition(Structure, int) 
447     */
448    public PPP_PCB_GOAL insertGOAL(int rep) throws HL7Exception { 
449       return (PPP_PCB_GOAL)super.insertRepetition("GOAL", rep);
450    }
451
452
453    /**
454     * Removes a specific repetition of GOAL (a Group object)
455     * @see AbstractGroup#removeRepetition(String, int) 
456     */
457    public PPP_PCB_GOAL removeGOAL(int rep) throws HL7Exception { 
458       return (PPP_PCB_GOAL)super.removeRepetition("GOAL", rep);
459    }
460
461
462
463    /**
464     * Returns
465     * the first repetition of 
466     * ORDER (a Group object) - creates it if necessary
467     */
468    public PPP_PCB_ORDER getORDER() { 
469       PPP_PCB_ORDER retVal = getTyped("ORDER", PPP_PCB_ORDER.class);
470       return retVal;
471    }
472
473
474    /**
475     * Returns a specific repetition of
476     * ORDER (a Group object) - creates it if necessary
477     *
478     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
479     * @throws HL7Exception if the repetition requested is more than one 
480     *     greater than the number of existing repetitions.
481     */
482    public PPP_PCB_ORDER getORDER(int rep) { 
483       PPP_PCB_ORDER retVal = getTyped("ORDER", rep, PPP_PCB_ORDER.class);
484       return retVal;
485    }
486
487    /** 
488     * Returns the number of existing repetitions of ORDER 
489     */ 
490    public int getORDERReps() {  
491        return getReps("ORDER");
492    } 
493
494    /** 
495     * <p>
496     * Returns a non-modifiable List containing all current existing repetitions of ORDER.
497     * <p>
498     * <p>
499     * Note that unlike {@link #getORDER()}, this method will not create any reps
500     * if none are already present, so an empty list may be returned.
501     * </p>
502     */ 
503    public java.util.List<PPP_PCB_ORDER> getORDERAll() throws HL7Exception {
504        return getAllAsList("ORDER", PPP_PCB_ORDER.class);
505    } 
506
507    /**
508     * Inserts a specific repetition of ORDER (a Group object)
509     * @see AbstractGroup#insertRepetition(Structure, int) 
510     */
511    public void insertORDER(PPP_PCB_ORDER structure, int rep) throws HL7Exception { 
512       super.insertRepetition("ORDER", structure, rep);
513    }
514
515
516    /**
517     * Inserts a specific repetition of ORDER (a Group object)
518     * @see AbstractGroup#insertRepetition(Structure, int) 
519     */
520    public PPP_PCB_ORDER insertORDER(int rep) throws HL7Exception { 
521       return (PPP_PCB_ORDER)super.insertRepetition("ORDER", rep);
522    }
523
524
525    /**
526     * Removes a specific repetition of ORDER (a Group object)
527     * @see AbstractGroup#removeRepetition(String, int) 
528     */
529    public PPP_PCB_ORDER removeORDER(int rep) throws HL7Exception { 
530       return (PPP_PCB_ORDER)super.removeRepetition("ORDER", rep);
531    }
532
533
534
535}
536