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 RDS_O01_NTERXRRXCNTE 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: NTE (NTE - notes and comments segment) <b> repeating </b></li>
49 * <li>2: RXR (RXR - pharmacy/treatment route segment) <b> repeating </b></li>
50 * <li>3: RDS_O01_RXCNTE (a Group object) <b>optional </b></li>
51 * </ul>
52 */
53 //@SuppressWarnings("unused")
54 public class RDS_O01_NTERXRRXCNTE extends AbstractGroup {
55
56 /**
57 * Creates a new RDS_O01_NTERXRRXCNTE group
58 */
59 public RDS_O01_NTERXRRXCNTE(Group parent, ModelClassFactory factory) {
60 super(parent, factory);
61 init(factory);
62 }
63
64 private void init(ModelClassFactory factory) {
65 try {
66 this.add(NTE.class, true, true, false);
67 this.add(RXR.class, true, true, false);
68 this.add(RDS_O01_RXCNTE.class, false, false, false);
69 } catch(HL7Exception e) {
70 log.error("Unexpected error creating RDS_O01_NTERXRRXCNTE - this is probably a bug in the source code generator.", e);
71 }
72 }
73
74 /**
75 * Returns "2.3.1"
76 */
77 public String getVersion() {
78 return "2.3.1";
79 }
80
81
82
83 /**
84 * Returns
85 * the first repetition of
86 * NTE (NTE - notes and comments segment) - creates it if necessary
87 */
88 public NTE getNTE() {
89 NTE retVal = getTyped("NTE", NTE.class);
90 return retVal;
91 }
92
93
94 /**
95 * Returns a specific repetition of
96 * NTE (NTE - notes and comments segment) - creates it if necessary
97 *
98 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
99 * @throws HL7Exception if the repetition requested is more than one
100 * greater than the number of existing repetitions.
101 */
102 public NTE getNTE(int rep) {
103 NTE retVal = getTyped("NTE", rep, NTE.class);
104 return retVal;
105 }
106
107 /**
108 * Returns the number of existing repetitions of NTE
109 */
110 public int getNTEReps() {
111 return getReps("NTE");
112 }
113
114 /**
115 * <p>
116 * Returns a non-modifiable List containing all current existing repetitions of NTE.
117 * <p>
118 * <p>
119 * Note that unlike {@link #getNTE()}, this method will not create any reps
120 * if none are already present, so an empty list may be returned.
121 * </p>
122 */
123 public java.util.List<NTE> getNTEAll() throws HL7Exception {
124 return getAllAsList("NTE", NTE.class);
125 }
126
127 /**
128 * Inserts a specific repetition of NTE (NTE - notes and comments segment)
129 * @see AbstractGroup#insertRepetition(Structure, int)
130 */
131 public void insertNTE(NTE structure, int rep) throws HL7Exception {
132 super.insertRepetition("NTE", structure, rep);
133 }
134
135
136 /**
137 * Inserts a specific repetition of NTE (NTE - notes and comments segment)
138 * @see AbstractGroup#insertRepetition(Structure, int)
139 */
140 public NTE insertNTE(int rep) throws HL7Exception {
141 return (NTE)super.insertRepetition("NTE", rep);
142 }
143
144
145 /**
146 * Removes a specific repetition of NTE (NTE - notes and comments segment)
147 * @see AbstractGroup#removeRepetition(String, int)
148 */
149 public NTE removeNTE(int rep) throws HL7Exception {
150 return (NTE)super.removeRepetition("NTE", rep);
151 }
152
153
154
155 /**
156 * Returns
157 * the first repetition of
158 * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
159 */
160 public RXR getRXR() {
161 RXR retVal = getTyped("RXR", RXR.class);
162 return retVal;
163 }
164
165
166 /**
167 * Returns a specific repetition of
168 * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary
169 *
170 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
171 * @throws HL7Exception if the repetition requested is more than one
172 * greater than the number of existing repetitions.
173 */
174 public RXR getRXR(int rep) {
175 RXR retVal = getTyped("RXR", rep, RXR.class);
176 return retVal;
177 }
178
179 /**
180 * Returns the number of existing repetitions of RXR
181 */
182 public int getRXRReps() {
183 return getReps("RXR");
184 }
185
186 /**
187 * <p>
188 * Returns a non-modifiable List containing all current existing repetitions of RXR.
189 * <p>
190 * <p>
191 * Note that unlike {@link #getRXR()}, this method will not create any reps
192 * if none are already present, so an empty list may be returned.
193 * </p>
194 */
195 public java.util.List<RXR> getRXRAll() throws HL7Exception {
196 return getAllAsList("RXR", RXR.class);
197 }
198
199 /**
200 * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
201 * @see AbstractGroup#insertRepetition(Structure, int)
202 */
203 public void insertRXR(RXR structure, int rep) throws HL7Exception {
204 super.insertRepetition("RXR", structure, rep);
205 }
206
207
208 /**
209 * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment)
210 * @see AbstractGroup#insertRepetition(Structure, int)
211 */
212 public RXR insertRXR(int rep) throws HL7Exception {
213 return (RXR)super.insertRepetition("RXR", rep);
214 }
215
216
217 /**
218 * Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment)
219 * @see AbstractGroup#removeRepetition(String, int)
220 */
221 public RXR removeRXR(int rep) throws HL7Exception {
222 return (RXR)super.removeRepetition("RXR", rep);
223 }
224
225
226
227 /**
228 * Returns
229 * RXCNTE (a Group object) - creates it if necessary
230 */
231 public RDS_O01_RXCNTE getRXCNTE() {
232 RDS_O01_RXCNTE retVal = getTyped("RXCNTE", RDS_O01_RXCNTE.class);
233 return retVal;
234 }
235
236
237
238
239 }
240