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