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.v28.group;
35
36 import ca.uhn.hl7v2.model.v28.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 BRP_O30_ORDER 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: ORC (Common Order) <b> </b></li>
49 * <li>2: PRT (Participation Information) <b>optional repeating </b></li>
50 * <li>3: BRP_O30_TIMING (a Group object) <b>optional repeating </b></li>
51 * <li>4: BPO (Blood product order) <b>optional </b></li>
52 * <li>5: BPX (Blood product dispense status) <b>optional repeating </b></li>
53 * </ul>
54 */
55 //@SuppressWarnings("unused")
56 public class BRP_O30_ORDER extends AbstractGroup {
57
58 /**
59 * Creates a new BRP_O30_ORDER group
60 */
61 public BRP_O30_ORDER(Group parent, ModelClassFactory factory) {
62 super(parent, factory);
63 init(factory);
64 }
65
66 private void init(ModelClassFactory factory) {
67 try {
68 this.add(ORC.class, true, false, false);
69 this.add(PRT.class, false, true, false);
70 this.add(BRP_O30_TIMING.class, false, true, false);
71 this.add(BPO.class, false, false, false);
72 this.add(BPX.class, false, true, false);
73 } catch(HL7Exception e) {
74 log.error("Unexpected error creating BRP_O30_ORDER - this is probably a bug in the source code generator.", e);
75 }
76 }
77
78 /**
79 * Returns "2.8"
80 */
81 public String getVersion() {
82 return "2.8";
83 }
84
85
86
87 /**
88 * Returns
89 * ORC (Common Order) - creates it if necessary
90 */
91 public ORC getORC() {
92 ORC retVal = getTyped("ORC", ORC.class);
93 return retVal;
94 }
95
96
97
98
99 /**
100 * Returns
101 * the first repetition of
102 * PRT (Participation Information) - creates it if necessary
103 */
104 public PRT getPRT() {
105 PRT retVal = getTyped("PRT", PRT.class);
106 return retVal;
107 }
108
109
110 /**
111 * Returns a specific repetition of
112 * PRT (Participation Information) - 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 PRT getPRT(int rep) {
119 PRT retVal = getTyped("PRT", rep, PRT.class);
120 return retVal;
121 }
122
123 /**
124 * Returns the number of existing repetitions of PRT
125 */
126 public int getPRTReps() {
127 return getReps("PRT");
128 }
129
130 /**
131 * <p>
132 * Returns a non-modifiable List containing all current existing repetitions of PRT.
133 * <p>
134 * <p>
135 * Note that unlike {@link #getPRT()}, 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<PRT> getPRTAll() throws HL7Exception {
140 return getAllAsList("PRT", PRT.class);
141 }
142
143 /**
144 * Inserts a specific repetition of PRT (Participation Information)
145 * @see AbstractGroup#insertRepetition(Structure, int)
146 */
147 public void insertPRT(PRT structure, int rep) throws HL7Exception {
148 super.insertRepetition("PRT", structure, rep);
149 }
150
151
152 /**
153 * Inserts a specific repetition of PRT (Participation Information)
154 * @see AbstractGroup#insertRepetition(Structure, int)
155 */
156 public PRT insertPRT(int rep) throws HL7Exception {
157 return (PRT)super.insertRepetition("PRT", rep);
158 }
159
160
161 /**
162 * Removes a specific repetition of PRT (Participation Information)
163 * @see AbstractGroup#removeRepetition(String, int)
164 */
165 public PRT removePRT(int rep) throws HL7Exception {
166 return (PRT)super.removeRepetition("PRT", rep);
167 }
168
169
170
171 /**
172 * Returns
173 * the first repetition of
174 * TIMING (a Group object) - creates it if necessary
175 */
176 public BRP_O30_TIMING getTIMING() {
177 BRP_O30_TIMING retVal = getTyped("TIMING", BRP_O30_TIMING.class);
178 return retVal;
179 }
180
181
182 /**
183 * Returns a specific repetition of
184 * TIMING (a Group object) - 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 BRP_O30_TIMING getTIMING(int rep) {
191 BRP_O30_TIMING retVal = getTyped("TIMING", rep, BRP_O30_TIMING.class);
192 return retVal;
193 }
194
195 /**
196 * Returns the number of existing repetitions of TIMING
197 */
198 public int getTIMINGReps() {
199 return getReps("TIMING");
200 }
201
202 /**
203 * <p>
204 * Returns a non-modifiable List containing all current existing repetitions of TIMING.
205 * <p>
206 * <p>
207 * Note that unlike {@link #getTIMING()}, 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<BRP_O30_TIMING> getTIMINGAll() throws HL7Exception {
212 return getAllAsList("TIMING", BRP_O30_TIMING.class);
213 }
214
215 /**
216 * Inserts a specific repetition of TIMING (a Group object)
217 * @see AbstractGroup#insertRepetition(Structure, int)
218 */
219 public void insertTIMING(BRP_O30_TIMING structure, int rep) throws HL7Exception {
220 super.insertRepetition("TIMING", structure, rep);
221 }
222
223
224 /**
225 * Inserts a specific repetition of TIMING (a Group object)
226 * @see AbstractGroup#insertRepetition(Structure, int)
227 */
228 public BRP_O30_TIMING insertTIMING(int rep) throws HL7Exception {
229 return (BRP_O30_TIMING)super.insertRepetition("TIMING", rep);
230 }
231
232
233 /**
234 * Removes a specific repetition of TIMING (a Group object)
235 * @see AbstractGroup#removeRepetition(String, int)
236 */
237 public BRP_O30_TIMING removeTIMING(int rep) throws HL7Exception {
238 return (BRP_O30_TIMING)super.removeRepetition("TIMING", rep);
239 }
240
241
242
243 /**
244 * Returns
245 * BPO (Blood product order) - creates it if necessary
246 */
247 public BPO getBPO() {
248 BPO retVal = getTyped("BPO", BPO.class);
249 return retVal;
250 }
251
252
253
254
255 /**
256 * Returns
257 * the first repetition of
258 * BPX (Blood product dispense status) - creates it if necessary
259 */
260 public BPX getBPX() {
261 BPX retVal = getTyped("BPX", BPX.class);
262 return retVal;
263 }
264
265
266 /**
267 * Returns a specific repetition of
268 * BPX (Blood product dispense status) - 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 BPX getBPX(int rep) {
275 BPX retVal = getTyped("BPX", rep, BPX.class);
276 return retVal;
277 }
278
279 /**
280 * Returns the number of existing repetitions of BPX
281 */
282 public int getBPXReps() {
283 return getReps("BPX");
284 }
285
286 /**
287 * <p>
288 * Returns a non-modifiable List containing all current existing repetitions of BPX.
289 * <p>
290 * <p>
291 * Note that unlike {@link #getBPX()}, 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<BPX> getBPXAll() throws HL7Exception {
296 return getAllAsList("BPX", BPX.class);
297 }
298
299 /**
300 * Inserts a specific repetition of BPX (Blood product dispense status)
301 * @see AbstractGroup#insertRepetition(Structure, int)
302 */
303 public void insertBPX(BPX structure, int rep) throws HL7Exception {
304 super.insertRepetition("BPX", structure, rep);
305 }
306
307
308 /**
309 * Inserts a specific repetition of BPX (Blood product dispense status)
310 * @see AbstractGroup#insertRepetition(Structure, int)
311 */
312 public BPX insertBPX(int rep) throws HL7Exception {
313 return (BPX)super.insertRepetition("BPX", rep);
314 }
315
316
317 /**
318 * Removes a specific repetition of BPX (Blood product dispense status)
319 * @see AbstractGroup#removeRepetition(String, int)
320 */
321 public BPX removeBPX(int rep) throws HL7Exception {
322 return (BPX)super.removeRepetition("BPX", rep);
323 }
324
325
326
327 }
328