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