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 ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE 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 (ORC - common order segment) <b>  </b></li>
049                         * <li>2: RDS_O01_RXONTERXRRXCNTE (a Group object) <b>optional  </b></li>
050                         * <li>3: RDS_O01_RXERXRRXC (a Group object) <b>optional  </b></li>
051                         * <li>4: RXD (RXD - pharmacy/treatment dispense segment) <b>  </b></li>
052                         * <li>5: RXR (RXR - pharmacy/treatment route segment) <b> repeating </b></li>
053                         * <li>6: RXC (RXC - pharmacy/treatment component order segment) <b>optional repeating </b></li>
054                         * <li>7: RDS_O01_OBXNTE (a Group object) <b>optional repeating </b></li>
055 * </ul>
056 */
057//@SuppressWarnings("unused")
058public class RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE extends AbstractGroup {
059
060    /** 
061     * Creates a new RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE group
062     */
063    public RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(ORC.class, true, false, false);
071                                  this.add(RDS_O01_RXONTERXRRXCNTE.class, false, false, false);
072                                  this.add(RDS_O01_RXERXRRXC.class, false, false, false);
073                                  this.add(RXD.class, true, false, false);
074                                  this.add(RXR.class, true, true, false);
075                                  this.add(RXC.class, false, true, false);
076                                  this.add(RDS_O01_OBXNTE.class, false, true, false);
077       } catch(HL7Exception e) {
078          log.error("Unexpected error creating RDS_O01_ORCRXONTERXRRXCNTERXERXRRXCRXDRXRRXCOBXNTE - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082    /** 
083     * Returns "2.3.1"
084     */
085    public String getVersion() {
086       return "2.3.1";
087    }
088
089
090
091    /**
092     * Returns
093     * ORC (ORC - common order segment) - creates it if necessary
094     */
095    public ORC getORC() { 
096       ORC retVal = getTyped("ORC", ORC.class);
097       return retVal;
098    }
099
100
101
102
103    /**
104     * Returns
105     * RXONTERXRRXCNTE (a Group object) - creates it if necessary
106     */
107    public RDS_O01_RXONTERXRRXCNTE getRXONTERXRRXCNTE() { 
108       RDS_O01_RXONTERXRRXCNTE retVal = getTyped("RXONTERXRRXCNTE", RDS_O01_RXONTERXRRXCNTE.class);
109       return retVal;
110    }
111
112
113
114
115    /**
116     * Returns
117     * RXERXRRXC (a Group object) - creates it if necessary
118     */
119    public RDS_O01_RXERXRRXC getRXERXRRXC() { 
120       RDS_O01_RXERXRRXC retVal = getTyped("RXERXRRXC", RDS_O01_RXERXRRXC.class);
121       return retVal;
122    }
123
124
125
126
127    /**
128     * Returns
129     * RXD (RXD - pharmacy/treatment dispense segment) - creates it if necessary
130     */
131    public RXD getRXD() { 
132       RXD retVal = getTyped("RXD", RXD.class);
133       return retVal;
134    }
135
136
137
138
139    /**
140     * Returns
141     * the first repetition of 
142     * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
143     */
144    public RXR getRXR() { 
145       RXR retVal = getTyped("RXR", RXR.class);
146       return retVal;
147    }
148
149
150    /**
151     * Returns a specific repetition of
152     * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
153     *
154     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
155     * @throws HL7Exception if the repetition requested is more than one 
156     *     greater than the number of existing repetitions.
157     */
158    public RXR getRXR(int rep) { 
159       RXR retVal = getTyped("RXR", rep, RXR.class);
160       return retVal;
161    }
162
163    /** 
164     * Returns the number of existing repetitions of RXR 
165     */ 
166    public int getRXRReps() {  
167        return getReps("RXR");
168    } 
169
170    /** 
171     * <p>
172     * Returns a non-modifiable List containing all current existing repetitions of RXR.
173     * <p>
174     * <p>
175     * Note that unlike {@link #getRXR()}, this method will not create any reps
176     * if none are already present, so an empty list may be returned.
177     * </p>
178     */ 
179    public java.util.List<RXR> getRXRAll() throws HL7Exception {
180        return getAllAsList("RXR", RXR.class);
181    } 
182
183    /**
184     * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
185     * @see AbstractGroup#insertRepetition(Structure, int) 
186     */
187    public void insertRXR(RXR structure, int rep) throws HL7Exception { 
188       super.insertRepetition("RXR", structure, rep);
189    }
190
191
192    /**
193     * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
194     * @see AbstractGroup#insertRepetition(Structure, int) 
195     */
196    public RXR insertRXR(int rep) throws HL7Exception { 
197       return (RXR)super.insertRepetition("RXR", rep);
198    }
199
200
201    /**
202     * Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)
203     * @see AbstractGroup#removeRepetition(String, int) 
204     */
205    public RXR removeRXR(int rep) throws HL7Exception { 
206       return (RXR)super.removeRepetition("RXR", rep);
207    }
208
209
210
211    /**
212     * Returns
213     * the first repetition of 
214     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
215     */
216    public RXC getRXC() { 
217       RXC retVal = getTyped("RXC", RXC.class);
218       return retVal;
219    }
220
221
222    /**
223     * Returns a specific repetition of
224     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
225     *
226     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
227     * @throws HL7Exception if the repetition requested is more than one 
228     *     greater than the number of existing repetitions.
229     */
230    public RXC getRXC(int rep) { 
231       RXC retVal = getTyped("RXC", rep, RXC.class);
232       return retVal;
233    }
234
235    /** 
236     * Returns the number of existing repetitions of RXC 
237     */ 
238    public int getRXCReps() {  
239        return getReps("RXC");
240    } 
241
242    /** 
243     * <p>
244     * Returns a non-modifiable List containing all current existing repetitions of RXC.
245     * <p>
246     * <p>
247     * Note that unlike {@link #getRXC()}, this method will not create any reps
248     * if none are already present, so an empty list may be returned.
249     * </p>
250     */ 
251    public java.util.List<RXC> getRXCAll() throws HL7Exception {
252        return getAllAsList("RXC", RXC.class);
253    } 
254
255    /**
256     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
257     * @see AbstractGroup#insertRepetition(Structure, int) 
258     */
259    public void insertRXC(RXC structure, int rep) throws HL7Exception { 
260       super.insertRepetition("RXC", structure, rep);
261    }
262
263
264    /**
265     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
266     * @see AbstractGroup#insertRepetition(Structure, int) 
267     */
268    public RXC insertRXC(int rep) throws HL7Exception { 
269       return (RXC)super.insertRepetition("RXC", rep);
270    }
271
272
273    /**
274     * Removes a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
275     * @see AbstractGroup#removeRepetition(String, int) 
276     */
277    public RXC removeRXC(int rep) throws HL7Exception { 
278       return (RXC)super.removeRepetition("RXC", rep);
279    }
280
281
282
283    /**
284     * Returns
285     * the first repetition of 
286     * OBXNTE (a Group object) - creates it if necessary
287     */
288    public RDS_O01_OBXNTE getOBXNTE() { 
289       RDS_O01_OBXNTE retVal = getTyped("OBXNTE", RDS_O01_OBXNTE.class);
290       return retVal;
291    }
292
293
294    /**
295     * Returns a specific repetition of
296     * OBXNTE (a Group object) - creates it if necessary
297     *
298     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
299     * @throws HL7Exception if the repetition requested is more than one 
300     *     greater than the number of existing repetitions.
301     */
302    public RDS_O01_OBXNTE getOBXNTE(int rep) { 
303       RDS_O01_OBXNTE retVal = getTyped("OBXNTE", rep, RDS_O01_OBXNTE.class);
304       return retVal;
305    }
306
307    /** 
308     * Returns the number of existing repetitions of OBXNTE 
309     */ 
310    public int getOBXNTEReps() {  
311        return getReps("OBXNTE");
312    } 
313
314    /** 
315     * <p>
316     * Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
317     * <p>
318     * <p>
319     * Note that unlike {@link #getOBXNTE()}, this method will not create any reps
320     * if none are already present, so an empty list may be returned.
321     * </p>
322     */ 
323    public java.util.List<RDS_O01_OBXNTE> getOBXNTEAll() throws HL7Exception {
324        return getAllAsList("OBXNTE", RDS_O01_OBXNTE.class);
325    } 
326
327    /**
328     * Inserts a specific repetition of OBXNTE (a Group object)
329     * @see AbstractGroup#insertRepetition(Structure, int) 
330     */
331    public void insertOBXNTE(RDS_O01_OBXNTE structure, int rep) throws HL7Exception { 
332       super.insertRepetition("OBXNTE", structure, rep);
333    }
334
335
336    /**
337     * Inserts a specific repetition of OBXNTE (a Group object)
338     * @see AbstractGroup#insertRepetition(Structure, int) 
339     */
340    public RDS_O01_OBXNTE insertOBXNTE(int rep) throws HL7Exception { 
341       return (RDS_O01_OBXNTE)super.insertRepetition("OBXNTE", rep);
342    }
343
344
345    /**
346     * Removes a specific repetition of OBXNTE (a Group object)
347     * @see AbstractGroup#removeRepetition(String, int) 
348     */
349    public RDS_O01_OBXNTE removeOBXNTE(int rep) throws HL7Exception { 
350       return (RDS_O01_OBXNTE)super.removeRepetition("OBXNTE", rep);
351    }
352
353
354
355}
356