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.v251.group;
035
036import ca.uhn.hl7v2.model.v251.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a OML_O35_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: OML_O35_TIMING (a Group object) <b>optional repeating </b></li>
050                         * <li>3: OML_O35_OBSERVATION_REQUEST (a Group object) <b>optional  </b></li>
051                         * <li>4: FT1 (Financial Transaction) <b>optional repeating </b></li>
052                         * <li>5: CTI (Clinical Trial Identification) <b>optional repeating </b></li>
053                         * <li>6: BLG (Billing) <b>optional  </b></li>
054 * </ul>
055 */
056//@SuppressWarnings("unused")
057public class OML_O35_ORDER extends AbstractGroup {
058
059    /** 
060     * Creates a new OML_O35_ORDER group
061     */
062    public OML_O35_ORDER(Group parent, ModelClassFactory factory) {
063       super(parent, factory);
064       init(factory);
065    }
066
067    private void init(ModelClassFactory factory) {
068       try {
069                                  this.add(ORC.class, true, false, false);
070                                  this.add(OML_O35_TIMING.class, false, true, false);
071                                  this.add(OML_O35_OBSERVATION_REQUEST.class, false, false, false);
072                                  this.add(FT1.class, false, true, false);
073                                  this.add(CTI.class, false, true, false);
074                                  this.add(BLG.class, false, false, false);
075       } catch(HL7Exception e) {
076          log.error("Unexpected error creating OML_O35_ORDER - this is probably a bug in the source code generator.", e);
077       }
078    }
079
080    /** 
081     * Returns "2.5.1"
082     */
083    public String getVersion() {
084       return "2.5.1";
085    }
086
087
088
089    /**
090     * Returns
091     * ORC (Common Order) - creates it if necessary
092     */
093    public ORC getORC() { 
094       ORC retVal = getTyped("ORC", ORC.class);
095       return retVal;
096    }
097
098
099
100
101    /**
102     * Returns
103     * the first repetition of 
104     * TIMING (a Group object) - creates it if necessary
105     */
106    public OML_O35_TIMING getTIMING() { 
107       OML_O35_TIMING retVal = getTyped("TIMING", OML_O35_TIMING.class);
108       return retVal;
109    }
110
111
112    /**
113     * Returns a specific repetition of
114     * TIMING (a Group object) - 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 OML_O35_TIMING getTIMING(int rep) { 
121       OML_O35_TIMING retVal = getTyped("TIMING", rep, OML_O35_TIMING.class);
122       return retVal;
123    }
124
125    /** 
126     * Returns the number of existing repetitions of TIMING 
127     */ 
128    public int getTIMINGReps() {  
129        return getReps("TIMING");
130    } 
131
132    /** 
133     * <p>
134     * Returns a non-modifiable List containing all current existing repetitions of TIMING.
135     * <p>
136     * <p>
137     * Note that unlike {@link #getTIMING()}, 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<OML_O35_TIMING> getTIMINGAll() throws HL7Exception {
142        return getAllAsList("TIMING", OML_O35_TIMING.class);
143    } 
144
145    /**
146     * Inserts a specific repetition of TIMING (a Group object)
147     * @see AbstractGroup#insertRepetition(Structure, int) 
148     */
149    public void insertTIMING(OML_O35_TIMING structure, int rep) throws HL7Exception { 
150       super.insertRepetition("TIMING", structure, rep);
151    }
152
153
154    /**
155     * Inserts a specific repetition of TIMING (a Group object)
156     * @see AbstractGroup#insertRepetition(Structure, int) 
157     */
158    public OML_O35_TIMING insertTIMING(int rep) throws HL7Exception { 
159       return (OML_O35_TIMING)super.insertRepetition("TIMING", rep);
160    }
161
162
163    /**
164     * Removes a specific repetition of TIMING (a Group object)
165     * @see AbstractGroup#removeRepetition(String, int) 
166     */
167    public OML_O35_TIMING removeTIMING(int rep) throws HL7Exception { 
168       return (OML_O35_TIMING)super.removeRepetition("TIMING", rep);
169    }
170
171
172
173    /**
174     * Returns
175     * OBSERVATION_REQUEST (a Group object) - creates it if necessary
176     */
177    public OML_O35_OBSERVATION_REQUEST getOBSERVATION_REQUEST() { 
178       OML_O35_OBSERVATION_REQUEST retVal = getTyped("OBSERVATION_REQUEST", OML_O35_OBSERVATION_REQUEST.class);
179       return retVal;
180    }
181
182
183
184
185    /**
186     * Returns
187     * the first repetition of 
188     * FT1 (Financial Transaction) - creates it if necessary
189     */
190    public FT1 getFT1() { 
191       FT1 retVal = getTyped("FT1", FT1.class);
192       return retVal;
193    }
194
195
196    /**
197     * Returns a specific repetition of
198     * FT1 (Financial Transaction) - creates it if necessary
199     *
200     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
201     * @throws HL7Exception if the repetition requested is more than one 
202     *     greater than the number of existing repetitions.
203     */
204    public FT1 getFT1(int rep) { 
205       FT1 retVal = getTyped("FT1", rep, FT1.class);
206       return retVal;
207    }
208
209    /** 
210     * Returns the number of existing repetitions of FT1 
211     */ 
212    public int getFT1Reps() {  
213        return getReps("FT1");
214    } 
215
216    /** 
217     * <p>
218     * Returns a non-modifiable List containing all current existing repetitions of FT1.
219     * <p>
220     * <p>
221     * Note that unlike {@link #getFT1()}, this method will not create any reps
222     * if none are already present, so an empty list may be returned.
223     * </p>
224     */ 
225    public java.util.List<FT1> getFT1All() throws HL7Exception {
226        return getAllAsList("FT1", FT1.class);
227    } 
228
229    /**
230     * Inserts a specific repetition of FT1 (Financial Transaction)
231     * @see AbstractGroup#insertRepetition(Structure, int) 
232     */
233    public void insertFT1(FT1 structure, int rep) throws HL7Exception { 
234       super.insertRepetition("FT1", structure, rep);
235    }
236
237
238    /**
239     * Inserts a specific repetition of FT1 (Financial Transaction)
240     * @see AbstractGroup#insertRepetition(Structure, int) 
241     */
242    public FT1 insertFT1(int rep) throws HL7Exception { 
243       return (FT1)super.insertRepetition("FT1", rep);
244    }
245
246
247    /**
248     * Removes a specific repetition of FT1 (Financial Transaction)
249     * @see AbstractGroup#removeRepetition(String, int) 
250     */
251    public FT1 removeFT1(int rep) throws HL7Exception { 
252       return (FT1)super.removeRepetition("FT1", rep);
253    }
254
255
256
257    /**
258     * Returns
259     * the first repetition of 
260     * CTI (Clinical Trial Identification) - creates it if necessary
261     */
262    public CTI getCTI() { 
263       CTI retVal = getTyped("CTI", CTI.class);
264       return retVal;
265    }
266
267
268    /**
269     * Returns a specific repetition of
270     * CTI (Clinical Trial Identification) - 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 CTI getCTI(int rep) { 
277       CTI retVal = getTyped("CTI", rep, CTI.class);
278       return retVal;
279    }
280
281    /** 
282     * Returns the number of existing repetitions of CTI 
283     */ 
284    public int getCTIReps() {  
285        return getReps("CTI");
286    } 
287
288    /** 
289     * <p>
290     * Returns a non-modifiable List containing all current existing repetitions of CTI.
291     * <p>
292     * <p>
293     * Note that unlike {@link #getCTI()}, 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<CTI> getCTIAll() throws HL7Exception {
298        return getAllAsList("CTI", CTI.class);
299    } 
300
301    /**
302     * Inserts a specific repetition of CTI (Clinical Trial Identification)
303     * @see AbstractGroup#insertRepetition(Structure, int) 
304     */
305    public void insertCTI(CTI structure, int rep) throws HL7Exception { 
306       super.insertRepetition("CTI", structure, rep);
307    }
308
309
310    /**
311     * Inserts a specific repetition of CTI (Clinical Trial Identification)
312     * @see AbstractGroup#insertRepetition(Structure, int) 
313     */
314    public CTI insertCTI(int rep) throws HL7Exception { 
315       return (CTI)super.insertRepetition("CTI", rep);
316    }
317
318
319    /**
320     * Removes a specific repetition of CTI (Clinical Trial Identification)
321     * @see AbstractGroup#removeRepetition(String, int) 
322     */
323    public CTI removeCTI(int rep) throws HL7Exception { 
324       return (CTI)super.removeRepetition("CTI", rep);
325    }
326
327
328
329    /**
330     * Returns
331     * BLG (Billing) - creates it if necessary
332     */
333    public BLG getBLG() { 
334       BLG retVal = getTyped("BLG", BLG.class);
335       return retVal;
336    }
337
338
339
340
341}
342