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.v28.group;
035
036import ca.uhn.hl7v2.model.v28.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a OMN_O07_ORDER 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: ORC (Common Order) <b>  </b></li>
049                         * <li>2: PRT (Participation Information) <b>optional repeating </b></li>
050                         * <li>3: OMN_O07_TIMING (a Group object) <b>optional repeating </b></li>
051                         * <li>4: RQD (Requisition Detail) <b>  </b></li>
052                         * <li>5: RQ1 (Requisition Detail-1) <b>optional  </b></li>
053                         * <li>6: NTE (Notes and Comments) <b>optional repeating </b></li>
054                         * <li>7: OMN_O07_OBSERVATION (a Group object) <b>optional repeating </b></li>
055                         * <li>8: BLG (Billing) <b>optional  </b></li>
056 * </ul>
057 */
058//@SuppressWarnings("unused")
059public class OMN_O07_ORDER extends AbstractGroup {
060
061    /** 
062     * Creates a new OMN_O07_ORDER group
063     */
064    public OMN_O07_ORDER(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                                  this.add(ORC.class, true, false, false);
072                                  this.add(PRT.class, false, true, false);
073                                  this.add(OMN_O07_TIMING.class, false, true, false);
074                                  this.add(RQD.class, true, false, false);
075                                  this.add(RQ1.class, false, false, false);
076                                  this.add(NTE.class, false, true, false);
077                                  this.add(OMN_O07_OBSERVATION.class, false, true, false);
078                                  this.add(BLG.class, false, false, false);
079       } catch(HL7Exception e) {
080          log.error("Unexpected error creating OMN_O07_ORDER - this is probably a bug in the source code generator.", e);
081       }
082    }
083
084    /** 
085     * Returns "2.8"
086     */
087    public String getVersion() {
088       return "2.8";
089    }
090
091
092
093    /**
094     * Returns
095     * ORC (Common Order) - creates it if necessary
096     */
097    public ORC getORC() { 
098       ORC retVal = getTyped("ORC", ORC.class);
099       return retVal;
100    }
101
102
103
104
105    /**
106     * Returns
107     * the first repetition of 
108     * PRT (Participation Information) - creates it if necessary
109     */
110    public PRT getPRT() { 
111       PRT retVal = getTyped("PRT", PRT.class);
112       return retVal;
113    }
114
115
116    /**
117     * Returns a specific repetition of
118     * PRT (Participation Information) - 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 PRT getPRT(int rep) { 
125       PRT retVal = getTyped("PRT", rep, PRT.class);
126       return retVal;
127    }
128
129    /** 
130     * Returns the number of existing repetitions of PRT 
131     */ 
132    public int getPRTReps() {  
133        return getReps("PRT");
134    } 
135
136    /** 
137     * <p>
138     * Returns a non-modifiable List containing all current existing repetitions of PRT.
139     * <p>
140     * <p>
141     * Note that unlike {@link #getPRT()}, 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<PRT> getPRTAll() throws HL7Exception {
146        return getAllAsList("PRT", PRT.class);
147    } 
148
149    /**
150     * Inserts a specific repetition of PRT (Participation Information)
151     * @see AbstractGroup#insertRepetition(Structure, int) 
152     */
153    public void insertPRT(PRT structure, int rep) throws HL7Exception { 
154       super.insertRepetition("PRT", structure, rep);
155    }
156
157
158    /**
159     * Inserts a specific repetition of PRT (Participation Information)
160     * @see AbstractGroup#insertRepetition(Structure, int) 
161     */
162    public PRT insertPRT(int rep) throws HL7Exception { 
163       return (PRT)super.insertRepetition("PRT", rep);
164    }
165
166
167    /**
168     * Removes a specific repetition of PRT (Participation Information)
169     * @see AbstractGroup#removeRepetition(String, int) 
170     */
171    public PRT removePRT(int rep) throws HL7Exception { 
172       return (PRT)super.removeRepetition("PRT", rep);
173    }
174
175
176
177    /**
178     * Returns
179     * the first repetition of 
180     * TIMING (a Group object) - creates it if necessary
181     */
182    public OMN_O07_TIMING getTIMING() { 
183       OMN_O07_TIMING retVal = getTyped("TIMING", OMN_O07_TIMING.class);
184       return retVal;
185    }
186
187
188    /**
189     * Returns a specific repetition of
190     * TIMING (a Group object) - 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 OMN_O07_TIMING getTIMING(int rep) { 
197       OMN_O07_TIMING retVal = getTyped("TIMING", rep, OMN_O07_TIMING.class);
198       return retVal;
199    }
200
201    /** 
202     * Returns the number of existing repetitions of TIMING 
203     */ 
204    public int getTIMINGReps() {  
205        return getReps("TIMING");
206    } 
207
208    /** 
209     * <p>
210     * Returns a non-modifiable List containing all current existing repetitions of TIMING.
211     * <p>
212     * <p>
213     * Note that unlike {@link #getTIMING()}, 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<OMN_O07_TIMING> getTIMINGAll() throws HL7Exception {
218        return getAllAsList("TIMING", OMN_O07_TIMING.class);
219    } 
220
221    /**
222     * Inserts a specific repetition of TIMING (a Group object)
223     * @see AbstractGroup#insertRepetition(Structure, int) 
224     */
225    public void insertTIMING(OMN_O07_TIMING structure, int rep) throws HL7Exception { 
226       super.insertRepetition("TIMING", structure, rep);
227    }
228
229
230    /**
231     * Inserts a specific repetition of TIMING (a Group object)
232     * @see AbstractGroup#insertRepetition(Structure, int) 
233     */
234    public OMN_O07_TIMING insertTIMING(int rep) throws HL7Exception { 
235       return (OMN_O07_TIMING)super.insertRepetition("TIMING", rep);
236    }
237
238
239    /**
240     * Removes a specific repetition of TIMING (a Group object)
241     * @see AbstractGroup#removeRepetition(String, int) 
242     */
243    public OMN_O07_TIMING removeTIMING(int rep) throws HL7Exception { 
244       return (OMN_O07_TIMING)super.removeRepetition("TIMING", rep);
245    }
246
247
248
249    /**
250     * Returns
251     * RQD (Requisition Detail) - creates it if necessary
252     */
253    public RQD getRQD() { 
254       RQD retVal = getTyped("RQD", RQD.class);
255       return retVal;
256    }
257
258
259
260
261    /**
262     * Returns
263     * RQ1 (Requisition Detail-1) - creates it if necessary
264     */
265    public RQ1 getRQ1() { 
266       RQ1 retVal = getTyped("RQ1", RQ1.class);
267       return retVal;
268    }
269
270
271
272
273    /**
274     * Returns
275     * the first repetition of 
276     * NTE (Notes and Comments) - creates it if necessary
277     */
278    public NTE getNTE() { 
279       NTE retVal = getTyped("NTE", NTE.class);
280       return retVal;
281    }
282
283
284    /**
285     * Returns a specific repetition of
286     * NTE (Notes and Comments) - creates it if necessary
287     *
288     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
289     * @throws HL7Exception if the repetition requested is more than one 
290     *     greater than the number of existing repetitions.
291     */
292    public NTE getNTE(int rep) { 
293       NTE retVal = getTyped("NTE", rep, NTE.class);
294       return retVal;
295    }
296
297    /** 
298     * Returns the number of existing repetitions of NTE 
299     */ 
300    public int getNTEReps() {  
301        return getReps("NTE");
302    } 
303
304    /** 
305     * <p>
306     * Returns a non-modifiable List containing all current existing repetitions of NTE.
307     * <p>
308     * <p>
309     * Note that unlike {@link #getNTE()}, this method will not create any reps
310     * if none are already present, so an empty list may be returned.
311     * </p>
312     */ 
313    public java.util.List<NTE> getNTEAll() throws HL7Exception {
314        return getAllAsList("NTE", NTE.class);
315    } 
316
317    /**
318     * Inserts a specific repetition of NTE (Notes and Comments)
319     * @see AbstractGroup#insertRepetition(Structure, int) 
320     */
321    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
322       super.insertRepetition("NTE", structure, rep);
323    }
324
325
326    /**
327     * Inserts a specific repetition of NTE (Notes and Comments)
328     * @see AbstractGroup#insertRepetition(Structure, int) 
329     */
330    public NTE insertNTE(int rep) throws HL7Exception { 
331       return (NTE)super.insertRepetition("NTE", rep);
332    }
333
334
335    /**
336     * Removes a specific repetition of NTE (Notes and Comments)
337     * @see AbstractGroup#removeRepetition(String, int) 
338     */
339    public NTE removeNTE(int rep) throws HL7Exception { 
340       return (NTE)super.removeRepetition("NTE", rep);
341    }
342
343
344
345    /**
346     * Returns
347     * the first repetition of 
348     * OBSERVATION (a Group object) - creates it if necessary
349     */
350    public OMN_O07_OBSERVATION getOBSERVATION() { 
351       OMN_O07_OBSERVATION retVal = getTyped("OBSERVATION", OMN_O07_OBSERVATION.class);
352       return retVal;
353    }
354
355
356    /**
357     * Returns a specific repetition of
358     * OBSERVATION (a Group object) - creates it if necessary
359     *
360     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
361     * @throws HL7Exception if the repetition requested is more than one 
362     *     greater than the number of existing repetitions.
363     */
364    public OMN_O07_OBSERVATION getOBSERVATION(int rep) { 
365       OMN_O07_OBSERVATION retVal = getTyped("OBSERVATION", rep, OMN_O07_OBSERVATION.class);
366       return retVal;
367    }
368
369    /** 
370     * Returns the number of existing repetitions of OBSERVATION 
371     */ 
372    public int getOBSERVATIONReps() {  
373        return getReps("OBSERVATION");
374    } 
375
376    /** 
377     * <p>
378     * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
379     * <p>
380     * <p>
381     * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
382     * if none are already present, so an empty list may be returned.
383     * </p>
384     */ 
385    public java.util.List<OMN_O07_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
386        return getAllAsList("OBSERVATION", OMN_O07_OBSERVATION.class);
387    } 
388
389    /**
390     * Inserts a specific repetition of OBSERVATION (a Group object)
391     * @see AbstractGroup#insertRepetition(Structure, int) 
392     */
393    public void insertOBSERVATION(OMN_O07_OBSERVATION structure, int rep) throws HL7Exception { 
394       super.insertRepetition("OBSERVATION", structure, rep);
395    }
396
397
398    /**
399     * Inserts a specific repetition of OBSERVATION (a Group object)
400     * @see AbstractGroup#insertRepetition(Structure, int) 
401     */
402    public OMN_O07_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 
403       return (OMN_O07_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
404    }
405
406
407    /**
408     * Removes a specific repetition of OBSERVATION (a Group object)
409     * @see AbstractGroup#removeRepetition(String, int) 
410     */
411    public OMN_O07_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 
412       return (OMN_O07_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
413    }
414
415
416
417    /**
418     * Returns
419     * BLG (Billing) - creates it if necessary
420     */
421    public BLG getBLG() { 
422       BLG retVal = getTyped("BLG", BLG.class);
423       return retVal;
424    }
425
426
427
428
429}
430