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.v231.group;
035
036import ca.uhn.hl7v2.model.v231.segment.*;
037
038import java.util.List;
039
040import ca.uhn.hl7v2.HL7Exception;
041import ca.uhn.hl7v2.parser.ModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044/**
045 * <p>Represents a RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI group structure (a Group object).
046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
047 * This Group contains the following elements:  
048 * </p>
049 * <ul>
050                 * <li>1: ORC (ORC - common order segment) <b> </b></li>
051                 * <li>2: RDE_O01_RXONTERXRRXCNTE (a Group object) <b>optional </b></li>
052                 * <li>3: RXE (RXE - pharmacy/treatment encoded order segment) <b> </b></li>
053                 * <li>4: RXR (RXR - pharmacy/treatment route segment) <b> repeating</b></li>
054                 * <li>5: RXC (RXC - pharmacy/treatment component order segment) <b>optional repeating</b></li>
055                 * <li>6: RDE_O01_OBXNTE (a Group object) <b>optional repeating</b></li>
056                 * <li>7: CTI (CTI - clinical trial identification segment) <b>optional repeating</b></li>
057 * </ul>
058 */
059@SuppressWarnings("unused")
060public class RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI extends AbstractGroup {
061
062    /** 
063     * Creates a new RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI group
064     */
065    public RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI(Group parent, ModelClassFactory factory) {
066       super(parent, factory);
067       init(factory);
068    }
069
070    private void init(ModelClassFactory factory) {
071       try {
072                          this.add(ORC.class, true, false);
073                          this.add(RDE_O01_RXONTERXRRXCNTE.class, false, false);
074                          this.add(RXE.class, true, false);
075                          this.add(RXR.class, true, true);
076                          this.add(RXC.class, false, true);
077                          this.add(RDE_O01_OBXNTE.class, false, true);
078                          this.add(CTI.class, false, true);
079       } catch(HL7Exception e) {
080          log.error("Unexpected error creating RDE_O01_ORCRXONTERXRRXCNTERXERXRRXCOBXNTECTI - this is probably a bug in the source code generator.", e);
081       }
082    }
083
084    /** 
085     * Returns "2.3.1"
086     */
087    public String getVersion() {
088       return "2.3.1";
089    }
090
091
092
093    /**
094     * Returns
095     * ORC (ORC - common order segment) - 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     * RXONTERXRRXCNTE (a Group object) - creates it if necessary
108     */
109    public RDE_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE() { 
110       RDE_O01_RXONTERXRRXCNTE retVal = getTyped("RXONTERXRRXCNTE", RDE_O01_RXONTERXRRXCNTE.class);
111       return retVal;
112    }
113
114
115
116
117    /**
118     * Returns
119     * RXE (RXE - pharmacy/treatment encoded order segment) - creates it if necessary
120     */
121    public RXE getRXE() { 
122       RXE retVal = getTyped("RXE", RXE.class);
123       return retVal;
124    }
125
126
127
128
129    /**
130     * Returns
131     * the first repetition of 
132     * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
133     */
134    public RXR getRXR() { 
135       RXR retVal = getTyped("RXR", RXR.class);
136       return retVal;
137    }
138
139
140    /**
141     * Returns a specific repetition of
142     * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
143     *
144     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
145     * @throws HL7Exception if the repetition requested is more than one 
146     *     greater than the number of existing repetitions.
147     */
148    public RXR getRXR(int rep) { 
149       RXR retVal = getTyped("RXR", rep, RXR.class);
150       return retVal;
151    }
152
153    /** 
154     * Returns the number of existing repetitions of RXR 
155     */ 
156    public int getRXRReps() {  
157        return getReps("RXR");
158    } 
159
160    /** 
161     * <p>
162     * Returns a non-modifiable List containing all current existing repetitions of RXR.
163     * <p>
164     * <p>
165     * Note that unlike {@link #getRXR()}, this method will not create any reps
166     * if none are already present, so an empty list may be returned.
167     * </p>
168     */ 
169    public List<RXR> getRXRAll() throws HL7Exception {
170        return getAllAsList("RXR", RXR.class);
171    } 
172
173    /**
174     * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
175     * @see AbstractGroup#insertRepetition(Structure, int) 
176     */
177    public void insertRXR(RXR structure, int rep) throws HL7Exception { 
178       super.insertRepetition("RXR", structure, rep);
179    }
180
181
182    /**
183     * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
184     * @see AbstractGroup#insertRepetition(Structure, int) 
185     */
186    public RXR insertRXR(int rep) throws HL7Exception { 
187       return (RXR)super.insertRepetition("RXR", rep);
188    }
189
190
191    /**
192     * Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)
193     * @see AbstractGroup#removeRepetition(String, int) 
194     */
195    public RXR removeRXR(int rep) throws HL7Exception { 
196       return (RXR)super.removeRepetition("RXR", rep);
197    }
198
199
200
201    /**
202     * Returns
203     * the first repetition of 
204     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
205     */
206    public RXC getRXC() { 
207       RXC retVal = getTyped("RXC", RXC.class);
208       return retVal;
209    }
210
211
212    /**
213     * Returns a specific repetition of
214     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
215     *
216     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
217     * @throws HL7Exception if the repetition requested is more than one 
218     *     greater than the number of existing repetitions.
219     */
220    public RXC getRXC(int rep) { 
221       RXC retVal = getTyped("RXC", rep, RXC.class);
222       return retVal;
223    }
224
225    /** 
226     * Returns the number of existing repetitions of RXC 
227     */ 
228    public int getRXCReps() {  
229        return getReps("RXC");
230    } 
231
232    /** 
233     * <p>
234     * Returns a non-modifiable List containing all current existing repetitions of RXC.
235     * <p>
236     * <p>
237     * Note that unlike {@link #getRXC()}, this method will not create any reps
238     * if none are already present, so an empty list may be returned.
239     * </p>
240     */ 
241    public List<RXC> getRXCAll() throws HL7Exception {
242        return getAllAsList("RXC", RXC.class);
243    } 
244
245    /**
246     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
247     * @see AbstractGroup#insertRepetition(Structure, int) 
248     */
249    public void insertRXC(RXC structure, int rep) throws HL7Exception { 
250       super.insertRepetition("RXC", structure, rep);
251    }
252
253
254    /**
255     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
256     * @see AbstractGroup#insertRepetition(Structure, int) 
257     */
258    public RXC insertRXC(int rep) throws HL7Exception { 
259       return (RXC)super.insertRepetition("RXC", rep);
260    }
261
262
263    /**
264     * Removes a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
265     * @see AbstractGroup#removeRepetition(String, int) 
266     */
267    public RXC removeRXC(int rep) throws HL7Exception { 
268       return (RXC)super.removeRepetition("RXC", rep);
269    }
270
271
272
273    /**
274     * Returns
275     * the first repetition of 
276     * OBXNTE (a Group object) - creates it if necessary
277     */
278    public RDE_O01_OBXNTE getOBXNTE() { 
279       RDE_O01_OBXNTE retVal = getTyped("OBXNTE", RDE_O01_OBXNTE.class);
280       return retVal;
281    }
282
283
284    /**
285     * Returns a specific repetition of
286     * OBXNTE (a Group object) - 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 RDE_O01_OBXNTE getOBXNTE(int rep) { 
293       RDE_O01_OBXNTE retVal = getTyped("OBXNTE", rep, RDE_O01_OBXNTE.class);
294       return retVal;
295    }
296
297    /** 
298     * Returns the number of existing repetitions of OBXNTE 
299     */ 
300    public int getOBXNTEReps() {  
301        return getReps("OBXNTE");
302    } 
303
304    /** 
305     * <p>
306     * Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
307     * <p>
308     * <p>
309     * Note that unlike {@link #getOBXNTE()}, 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 List<RDE_O01_OBXNTE> getOBXNTEAll() throws HL7Exception {
314        return getAllAsList("OBXNTE", RDE_O01_OBXNTE.class);
315    } 
316
317    /**
318     * Inserts a specific repetition of OBXNTE (a Group object)
319     * @see AbstractGroup#insertRepetition(Structure, int) 
320     */
321    public void insertOBXNTE(RDE_O01_OBXNTE structure, int rep) throws HL7Exception { 
322       super.insertRepetition("OBXNTE", structure, rep);
323    }
324
325
326    /**
327     * Inserts a specific repetition of OBXNTE (a Group object)
328     * @see AbstractGroup#insertRepetition(Structure, int) 
329     */
330    public RDE_O01_OBXNTE insertOBXNTE(int rep) throws HL7Exception { 
331       return (RDE_O01_OBXNTE)super.insertRepetition("OBXNTE", rep);
332    }
333
334
335    /**
336     * Removes a specific repetition of OBXNTE (a Group object)
337     * @see AbstractGroup#removeRepetition(String, int) 
338     */
339    public RDE_O01_OBXNTE removeOBXNTE(int rep) throws HL7Exception { 
340       return (RDE_O01_OBXNTE)super.removeRepetition("OBXNTE", rep);
341    }
342
343
344
345    /**
346     * Returns
347     * the first repetition of 
348     * CTI (CTI - clinical trial identification segment) - creates it if necessary
349     */
350    public CTI getCTI() { 
351       CTI retVal = getTyped("CTI", CTI.class);
352       return retVal;
353    }
354
355
356    /**
357     * Returns a specific repetition of
358     * CTI (CTI - clinical trial identification segment) - 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 CTI getCTI(int rep) { 
365       CTI retVal = getTyped("CTI", rep, CTI.class);
366       return retVal;
367    }
368
369    /** 
370     * Returns the number of existing repetitions of CTI 
371     */ 
372    public int getCTIReps() {  
373        return getReps("CTI");
374    } 
375
376    /** 
377     * <p>
378     * Returns a non-modifiable List containing all current existing repetitions of CTI.
379     * <p>
380     * <p>
381     * Note that unlike {@link #getCTI()}, 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 List<CTI> getCTIAll() throws HL7Exception {
386        return getAllAsList("CTI", CTI.class);
387    } 
388
389    /**
390     * Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
391     * @see AbstractGroup#insertRepetition(Structure, int) 
392     */
393    public void insertCTI(CTI structure, int rep) throws HL7Exception { 
394       super.insertRepetition("CTI", structure, rep);
395    }
396
397
398    /**
399     * Inserts a specific repetition of CTI (CTI - clinical trial identification segment)
400     * @see AbstractGroup#insertRepetition(Structure, int) 
401     */
402    public CTI insertCTI(int rep) throws HL7Exception { 
403       return (CTI)super.insertRepetition("CTI", rep);
404    }
405
406
407    /**
408     * Removes a specific repetition of CTI (CTI - clinical trial identification segment)
409     * @see AbstractGroup#removeRepetition(String, int) 
410     */
411    public CTI removeCTI(int rep) throws HL7Exception { 
412       return (CTI)super.removeRepetition("CTI", rep);
413    }
414
415
416
417}
418