Source code

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