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