View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v231.group;
35  
36  import ca.uhn.hl7v2.model.v231.segment.*;
37  
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.model.*;
41  
42  /**
43   * <p>Represents a RDO_O01_RXONTERXRRXCNTEOBXNTE group structure (a Group object).
44   * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45   * This Group contains the following elements:  
46   * </p>
47   * <ul>
48                           * <li>1: RXO (RXO - pharmacy/treatment order segment) <b>  </b></li>
49                           * <li>2: NTE (NTE - notes and comments segment) <b>optional repeating </b></li>
50                           * <li>3: RXR (RXR - pharmacy/treatment route segment) <b> repeating </b></li>
51                           * <li>4: RDO_O01_RXCNTE (a Group object) <b>optional  </b></li>
52                           * <li>5: RDO_O01_OBXNTE (a Group object) <b>optional repeating </b></li>
53   * </ul>
54   */
55  //@SuppressWarnings("unused")
56  public class RDO_O01_RXONTERXRRXCNTEOBXNTE extends AbstractGroup {
57  
58      /** 
59       * Creates a new RDO_O01_RXONTERXRRXCNTEOBXNTE group
60       */
61      public RDO_O01_RXONTERXRRXCNTEOBXNTE(Group parent, ModelClassFactory factory) {
62         super(parent, factory);
63         init(factory);
64      }
65  
66      private void init(ModelClassFactory factory) {
67         try {
68                                    this.add(RXO.class, true, false, false);
69                                    this.add(NTE.class, false, true, false);
70                                    this.add(RXR.class, true, true, false);
71                                    this.add(RDO_O01_RXCNTE.class, false, false, false);
72                                    this.add(RDO_O01_OBXNTE.class, false, true, false);
73         } catch(HL7Exception e) {
74            log.error("Unexpected error creating RDO_O01_RXONTERXRRXCNTEOBXNTE - this is probably a bug in the source code generator.", e);
75         }
76      }
77  
78      /** 
79       * Returns "2.3.1"
80       */
81      public String getVersion() {
82         return "2.3.1";
83      }
84  
85  
86  
87      /**
88       * Returns
89       * RXO (RXO - pharmacy/treatment order segment) - creates it if necessary
90       */
91      public RXO getRXO() { 
92         RXO retVal = getTyped("RXO", RXO.class);
93         return retVal;
94      }
95  
96  
97  
98  
99      /**
100      * Returns
101      * the first repetition of 
102      * NTE (NTE - notes and comments segment) - creates it if necessary
103      */
104     public NTE getNTE() { 
105        NTE retVal = getTyped("NTE", NTE.class);
106        return retVal;
107     }
108 
109 
110     /**
111      * Returns a specific repetition of
112      * NTE (NTE - notes and comments segment) - creates it if necessary
113      *
114      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
115      * @throws HL7Exception if the repetition requested is more than one 
116      *     greater than the number of existing repetitions.
117      */
118     public NTE getNTE(int rep) { 
119        NTE retVal = getTyped("NTE", rep, NTE.class);
120        return retVal;
121     }
122 
123     /** 
124      * Returns the number of existing repetitions of NTE 
125      */ 
126     public int getNTEReps() {  
127         return getReps("NTE");
128     } 
129 
130     /** 
131      * <p>
132      * Returns a non-modifiable List containing all current existing repetitions of NTE.
133      * <p>
134      * <p>
135      * Note that unlike {@link #getNTE()}, this method will not create any reps
136      * if none are already present, so an empty list may be returned.
137      * </p>
138      */ 
139     public java.util.List<NTE> getNTEAll() throws HL7Exception {
140     	return getAllAsList("NTE", NTE.class);
141     } 
142 
143     /**
144      * Inserts a specific repetition of NTE (NTE - notes and comments segment)
145      * @see AbstractGroup#insertRepetition(Structure, int) 
146      */
147     public void insertNTE(NTE structure, int rep) throws HL7Exception { 
148        super.insertRepetition("NTE", structure, rep);
149     }
150 
151 
152     /**
153      * Inserts a specific repetition of NTE (NTE - notes and comments segment)
154      * @see AbstractGroup#insertRepetition(Structure, int) 
155      */
156     public NTE insertNTE(int rep) throws HL7Exception { 
157        return (NTE)super.insertRepetition("NTE", rep);
158     }
159 
160 
161     /**
162      * Removes a specific repetition of NTE (NTE - notes and comments segment)
163      * @see AbstractGroup#removeRepetition(String, int) 
164      */
165     public NTE removeNTE(int rep) throws HL7Exception { 
166        return (NTE)super.removeRepetition("NTE", rep);
167     }
168 
169 
170 
171     /**
172      * Returns
173      * the first repetition of 
174      * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
175      */
176     public RXR getRXR() { 
177        RXR retVal = getTyped("RXR", RXR.class);
178        return retVal;
179     }
180 
181 
182     /**
183      * Returns a specific repetition of
184      * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
185      *
186      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
187      * @throws HL7Exception if the repetition requested is more than one 
188      *     greater than the number of existing repetitions.
189      */
190     public RXR getRXR(int rep) { 
191        RXR retVal = getTyped("RXR", rep, RXR.class);
192        return retVal;
193     }
194 
195     /** 
196      * Returns the number of existing repetitions of RXR 
197      */ 
198     public int getRXRReps() {  
199         return getReps("RXR");
200     } 
201 
202     /** 
203      * <p>
204      * Returns a non-modifiable List containing all current existing repetitions of RXR.
205      * <p>
206      * <p>
207      * Note that unlike {@link #getRXR()}, this method will not create any reps
208      * if none are already present, so an empty list may be returned.
209      * </p>
210      */ 
211     public java.util.List<RXR> getRXRAll() throws HL7Exception {
212     	return getAllAsList("RXR", RXR.class);
213     } 
214 
215     /**
216      * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
217      * @see AbstractGroup#insertRepetition(Structure, int) 
218      */
219     public void insertRXR(RXR structure, int rep) throws HL7Exception { 
220        super.insertRepetition("RXR", structure, rep);
221     }
222 
223 
224     /**
225      * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
226      * @see AbstractGroup#insertRepetition(Structure, int) 
227      */
228     public RXR insertRXR(int rep) throws HL7Exception { 
229        return (RXR)super.insertRepetition("RXR", rep);
230     }
231 
232 
233     /**
234      * Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)
235      * @see AbstractGroup#removeRepetition(String, int) 
236      */
237     public RXR removeRXR(int rep) throws HL7Exception { 
238        return (RXR)super.removeRepetition("RXR", rep);
239     }
240 
241 
242 
243     /**
244      * Returns
245      * RXCNTE (a Group object) - creates it if necessary
246      */
247     public RDO_O01_RXCNTE getRXCNTE() { 
248        RDO_O01_RXCNTE retVal = getTyped("RXCNTE", RDO_O01_RXCNTE.class);
249        return retVal;
250     }
251 
252 
253 
254 
255     /**
256      * Returns
257      * the first repetition of 
258      * OBXNTE (a Group object) - creates it if necessary
259      */
260     public RDO_O01_OBXNTE getOBXNTE() { 
261        RDO_O01_OBXNTE retVal = getTyped("OBXNTE", RDO_O01_OBXNTE.class);
262        return retVal;
263     }
264 
265 
266     /**
267      * Returns a specific repetition of
268      * OBXNTE (a Group object) - 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 RDO_O01_OBXNTE getOBXNTE(int rep) { 
275        RDO_O01_OBXNTE retVal = getTyped("OBXNTE", rep, RDO_O01_OBXNTE.class);
276        return retVal;
277     }
278 
279     /** 
280      * Returns the number of existing repetitions of OBXNTE 
281      */ 
282     public int getOBXNTEReps() {  
283         return getReps("OBXNTE");
284     } 
285 
286     /** 
287      * <p>
288      * Returns a non-modifiable List containing all current existing repetitions of OBXNTE.
289      * <p>
290      * <p>
291      * Note that unlike {@link #getOBXNTE()}, 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<RDO_O01_OBXNTE> getOBXNTEAll() throws HL7Exception {
296     	return getAllAsList("OBXNTE", RDO_O01_OBXNTE.class);
297     } 
298 
299     /**
300      * Inserts a specific repetition of OBXNTE (a Group object)
301      * @see AbstractGroup#insertRepetition(Structure, int) 
302      */
303     public void insertOBXNTE(RDO_O01_OBXNTE structure, int rep) throws HL7Exception { 
304        super.insertRepetition("OBXNTE", structure, rep);
305     }
306 
307 
308     /**
309      * Inserts a specific repetition of OBXNTE (a Group object)
310      * @see AbstractGroup#insertRepetition(Structure, int) 
311      */
312     public RDO_O01_OBXNTE insertOBXNTE(int rep) throws HL7Exception { 
313        return (RDO_O01_OBXNTE)super.insertRepetition("OBXNTE", rep);
314     }
315 
316 
317     /**
318      * Removes a specific repetition of OBXNTE (a Group object)
319      * @see AbstractGroup#removeRepetition(String, int) 
320      */
321     public RDO_O01_OBXNTE removeOBXNTE(int rep) throws HL7Exception { 
322        return (RDO_O01_OBXNTE)super.removeRepetition("OBXNTE", rep);
323     }
324 
325 
326 
327 }
328