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 RER_RER_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: RXE (Pharmacy/Treatment Encoded Order) <b>  </b></li>
050                         * <li>3: RXR (Pharmacy/Treatment Route) <b> repeating </b></li>
051                         * <li>4: RXC (Pharmacy/Treatment Component Order) <b>optional repeating </b></li>
052 * </ul>
053 */
054//@SuppressWarnings("unused")
055public class RER_RER_ORDER extends AbstractGroup {
056
057    /** 
058     * Creates a new RER_RER_ORDER group
059     */
060    public RER_RER_ORDER(Group parent, ModelClassFactory factory) {
061       super(parent, factory);
062       init(factory);
063    }
064
065    private void init(ModelClassFactory factory) {
066       try {
067                                  this.add(ORC.class, true, false, false);
068                                  this.add(RXE.class, true, false, false);
069                                  this.add(RXR.class, true, true, false);
070                                  this.add(RXC.class, false, true, false);
071       } catch(HL7Exception e) {
072          log.error("Unexpected error creating RER_RER_ORDER - this is probably a bug in the source code generator.", e);
073       }
074    }
075
076    /** 
077     * Returns "2.5.1"
078     */
079    public String getVersion() {
080       return "2.5.1";
081    }
082
083
084
085    /**
086     * Returns
087     * ORC (Common Order) - creates it if necessary
088     */
089    public ORC getORC() { 
090       ORC retVal = getTyped("ORC", ORC.class);
091       return retVal;
092    }
093
094
095
096
097    /**
098     * Returns
099     * RXE (Pharmacy/Treatment Encoded Order) - creates it if necessary
100     */
101    public RXE getRXE() { 
102       RXE retVal = getTyped("RXE", RXE.class);
103       return retVal;
104    }
105
106
107
108
109    /**
110     * Returns
111     * the first repetition of 
112     * RXR (Pharmacy/Treatment Route) - creates it if necessary
113     */
114    public RXR getRXR() { 
115       RXR retVal = getTyped("RXR", RXR.class);
116       return retVal;
117    }
118
119
120    /**
121     * Returns a specific repetition of
122     * RXR (Pharmacy/Treatment Route) - creates it if necessary
123     *
124     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
125     * @throws HL7Exception if the repetition requested is more than one 
126     *     greater than the number of existing repetitions.
127     */
128    public RXR getRXR(int rep) { 
129       RXR retVal = getTyped("RXR", rep, RXR.class);
130       return retVal;
131    }
132
133    /** 
134     * Returns the number of existing repetitions of RXR 
135     */ 
136    public int getRXRReps() {  
137        return getReps("RXR");
138    } 
139
140    /** 
141     * <p>
142     * Returns a non-modifiable List containing all current existing repetitions of RXR.
143     * <p>
144     * <p>
145     * Note that unlike {@link #getRXR()}, this method will not create any reps
146     * if none are already present, so an empty list may be returned.
147     * </p>
148     */ 
149    public java.util.List<RXR> getRXRAll() throws HL7Exception {
150        return getAllAsList("RXR", RXR.class);
151    } 
152
153    /**
154     * Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
155     * @see AbstractGroup#insertRepetition(Structure, int) 
156     */
157    public void insertRXR(RXR structure, int rep) throws HL7Exception { 
158       super.insertRepetition("RXR", structure, rep);
159    }
160
161
162    /**
163     * Inserts a specific repetition of RXR (Pharmacy/Treatment Route)
164     * @see AbstractGroup#insertRepetition(Structure, int) 
165     */
166    public RXR insertRXR(int rep) throws HL7Exception { 
167       return (RXR)super.insertRepetition("RXR", rep);
168    }
169
170
171    /**
172     * Removes a specific repetition of RXR (Pharmacy/Treatment Route)
173     * @see AbstractGroup#removeRepetition(String, int) 
174     */
175    public RXR removeRXR(int rep) throws HL7Exception { 
176       return (RXR)super.removeRepetition("RXR", rep);
177    }
178
179
180
181    /**
182     * Returns
183     * the first repetition of 
184     * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
185     */
186    public RXC getRXC() { 
187       RXC retVal = getTyped("RXC", RXC.class);
188       return retVal;
189    }
190
191
192    /**
193     * Returns a specific repetition of
194     * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
195     *
196     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
197     * @throws HL7Exception if the repetition requested is more than one 
198     *     greater than the number of existing repetitions.
199     */
200    public RXC getRXC(int rep) { 
201       RXC retVal = getTyped("RXC", rep, RXC.class);
202       return retVal;
203    }
204
205    /** 
206     * Returns the number of existing repetitions of RXC 
207     */ 
208    public int getRXCReps() {  
209        return getReps("RXC");
210    } 
211
212    /** 
213     * <p>
214     * Returns a non-modifiable List containing all current existing repetitions of RXC.
215     * <p>
216     * <p>
217     * Note that unlike {@link #getRXC()}, this method will not create any reps
218     * if none are already present, so an empty list may be returned.
219     * </p>
220     */ 
221    public java.util.List<RXC> getRXCAll() throws HL7Exception {
222        return getAllAsList("RXC", RXC.class);
223    } 
224
225    /**
226     * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
227     * @see AbstractGroup#insertRepetition(Structure, int) 
228     */
229    public void insertRXC(RXC structure, int rep) throws HL7Exception { 
230       super.insertRepetition("RXC", structure, rep);
231    }
232
233
234    /**
235     * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
236     * @see AbstractGroup#insertRepetition(Structure, int) 
237     */
238    public RXC insertRXC(int rep) throws HL7Exception { 
239       return (RXC)super.insertRepetition("RXC", rep);
240    }
241
242
243    /**
244     * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
245     * @see AbstractGroup#removeRepetition(String, int) 
246     */
247    public RXC removeRXC(int rep) throws HL7Exception { 
248       return (RXC)super.removeRepetition("RXC", rep);
249    }
250
251
252
253}
254