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.v25.message;
35
36 import ca.uhn.hl7v2.model.v25.group.*;
37 import ca.uhn.hl7v2.model.v25.segment.*;
38
39 import ca.uhn.hl7v2.HL7Exception;
40 import ca.uhn.hl7v2.parser.ModelClassFactory;
41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42 import ca.uhn.hl7v2.model.*;
43
44
45 /**
46 * <p>Represents a BRP_O30 message structure (see chapter 4.20.4). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (Message Header) <b> </b> </li>
50 * <li>2: MSA (Message Acknowledgment) <b> </b> </li>
51 * <li>3: ERR (Error) <b>optional repeating</b> </li>
52 * <li>4: SFT (Software Segment) <b>optional repeating</b> </li>
53 * <li>5: NTE (Notes and Comments) <b>optional repeating</b> </li>
54 * <li>6: BRP_O30_RESPONSE (a Group object) <b>optional </b> </li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class BRP_O30 extends AbstractMessage {
59
60 /**
61 * Creates a new BRP_O30 message with DefaultModelClassFactory.
62 */
63 public BRP_O30() {
64 this(new DefaultModelClassFactory());
65 }
66
67 /**
68 * Creates a new BRP_O30 message with custom ModelClassFactory.
69 */
70 public BRP_O30(ModelClassFactory factory) {
71 super(factory);
72 init(factory);
73 }
74
75 private void init(ModelClassFactory factory) {
76 try {
77 this.add(MSH.class, true, false);
78 this.add(MSA.class, true, false);
79 this.add(ERR.class, false, true);
80 this.add(SFT.class, false, true);
81 this.add(NTE.class, false, true);
82 this.add(BRP_O30_RESPONSE.class, false, false);
83 } catch(HL7Exception e) {
84 log.error("Unexpected error creating BRP_O30 - this is probably a bug in the source code generator.", e);
85 }
86 }
87
88
89 /**
90 * Returns "2.5"
91 */
92 public String getVersion() {
93 return "2.5";
94 }
95
96
97
98
99 /**
100 * <p>
101 * Returns
102 * MSH (Message Header) - creates it if necessary
103 * </p>
104 *
105 *
106 */
107 public MSH getMSH() {
108 return getTyped("MSH", MSH.class);
109 }
110
111
112
113
114
115 /**
116 * <p>
117 * Returns
118 * MSA (Message Acknowledgment) - creates it if necessary
119 * </p>
120 *
121 *
122 */
123 public MSA getMSA() {
124 return getTyped("MSA", MSA.class);
125 }
126
127
128
129
130
131 /**
132 * <p>
133 * Returns
134 * the first repetition of
135 * ERR (Error) - creates it if necessary
136 * </p>
137 *
138 *
139 */
140 public ERR getERR() {
141 return getTyped("ERR", ERR.class);
142 }
143
144
145 /**
146 * <p>
147 * Returns a specific repetition of
148 * ERR (Error) - creates it if necessary
149 * </p>
150 *
151 *
152 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
153 * @throws HL7Exception if the repetition requested is more than one
154 * greater than the number of existing repetitions.
155 */
156 public ERR getERR(int rep) {
157 return getTyped("ERR", rep, ERR.class);
158 }
159
160 /**
161 * <p>
162 * Returns the number of existing repetitions of ERR
163 * </p>
164 *
165 */
166 public int getERRReps() {
167 return getReps("ERR");
168 }
169
170 /**
171 * <p>
172 * Returns a non-modifiable List containing all current existing repetitions of ERR.
173 * <p>
174 * <p>
175 * Note that unlike {@link #getERR()}, this method will not create any reps
176 * if none are already present, so an empty list may be returned.
177 * </p>
178 *
179 */
180 public java.util.List<ERR> getERRAll() throws HL7Exception {
181 return getAllAsList("ERR", ERR.class);
182 }
183
184 /**
185 * <p>
186 * Inserts a specific repetition of ERR (Error)
187 * </p>
188 *
189 *
190 * @see AbstractGroup#insertRepetition(Structure, int)
191 */
192 public void insertERR(ERR structure, int rep) throws HL7Exception {
193 super.insertRepetition( "ERR", structure, rep);
194 }
195
196
197 /**
198 * <p>
199 * Inserts a specific repetition of ERR (Error)
200 * </p>
201 *
202 *
203 * @see AbstractGroup#insertRepetition(Structure, int)
204 */
205 public ERR insertERR(int rep) throws HL7Exception {
206 return (ERR)super.insertRepetition("ERR", rep);
207 }
208
209
210 /**
211 * <p>
212 * Removes a specific repetition of ERR (Error)
213 * </p>
214 *
215 *
216 * @see AbstractGroup#removeRepetition(String, int)
217 */
218 public ERR removeERR(int rep) throws HL7Exception {
219 return (ERR)super.removeRepetition("ERR", rep);
220 }
221
222
223
224
225 /**
226 * <p>
227 * Returns
228 * the first repetition of
229 * SFT (Software Segment) - creates it if necessary
230 * </p>
231 *
232 *
233 */
234 public SFT getSFT() {
235 return getTyped("SFT", SFT.class);
236 }
237
238
239 /**
240 * <p>
241 * Returns a specific repetition of
242 * SFT (Software Segment) - creates it if necessary
243 * </p>
244 *
245 *
246 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
247 * @throws HL7Exception if the repetition requested is more than one
248 * greater than the number of existing repetitions.
249 */
250 public SFT getSFT(int rep) {
251 return getTyped("SFT", rep, SFT.class);
252 }
253
254 /**
255 * <p>
256 * Returns the number of existing repetitions of SFT
257 * </p>
258 *
259 */
260 public int getSFTReps() {
261 return getReps("SFT");
262 }
263
264 /**
265 * <p>
266 * Returns a non-modifiable List containing all current existing repetitions of SFT.
267 * <p>
268 * <p>
269 * Note that unlike {@link #getSFT()}, this method will not create any reps
270 * if none are already present, so an empty list may be returned.
271 * </p>
272 *
273 */
274 public java.util.List<SFT> getSFTAll() throws HL7Exception {
275 return getAllAsList("SFT", SFT.class);
276 }
277
278 /**
279 * <p>
280 * Inserts a specific repetition of SFT (Software Segment)
281 * </p>
282 *
283 *
284 * @see AbstractGroup#insertRepetition(Structure, int)
285 */
286 public void insertSFT(SFT structure, int rep) throws HL7Exception {
287 super.insertRepetition( "SFT", structure, rep);
288 }
289
290
291 /**
292 * <p>
293 * Inserts a specific repetition of SFT (Software Segment)
294 * </p>
295 *
296 *
297 * @see AbstractGroup#insertRepetition(Structure, int)
298 */
299 public SFT insertSFT(int rep) throws HL7Exception {
300 return (SFT)super.insertRepetition("SFT", rep);
301 }
302
303
304 /**
305 * <p>
306 * Removes a specific repetition of SFT (Software Segment)
307 * </p>
308 *
309 *
310 * @see AbstractGroup#removeRepetition(String, int)
311 */
312 public SFT removeSFT(int rep) throws HL7Exception {
313 return (SFT)super.removeRepetition("SFT", rep);
314 }
315
316
317
318
319 /**
320 * <p>
321 * Returns
322 * the first repetition of
323 * NTE (Notes and Comments) - creates it if necessary
324 * </p>
325 *
326 *
327 */
328 public NTE getNTE() {
329 return getTyped("NTE", NTE.class);
330 }
331
332
333 /**
334 * <p>
335 * Returns a specific repetition of
336 * NTE (Notes and Comments) - creates it if necessary
337 * </p>
338 *
339 *
340 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
341 * @throws HL7Exception if the repetition requested is more than one
342 * greater than the number of existing repetitions.
343 */
344 public NTE getNTE(int rep) {
345 return getTyped("NTE", rep, NTE.class);
346 }
347
348 /**
349 * <p>
350 * Returns the number of existing repetitions of NTE
351 * </p>
352 *
353 */
354 public int getNTEReps() {
355 return getReps("NTE");
356 }
357
358 /**
359 * <p>
360 * Returns a non-modifiable List containing all current existing repetitions of NTE.
361 * <p>
362 * <p>
363 * Note that unlike {@link #getNTE()}, this method will not create any reps
364 * if none are already present, so an empty list may be returned.
365 * </p>
366 *
367 */
368 public java.util.List<NTE> getNTEAll() throws HL7Exception {
369 return getAllAsList("NTE", NTE.class);
370 }
371
372 /**
373 * <p>
374 * Inserts a specific repetition of NTE (Notes and Comments)
375 * </p>
376 *
377 *
378 * @see AbstractGroup#insertRepetition(Structure, int)
379 */
380 public void insertNTE(NTE structure, int rep) throws HL7Exception {
381 super.insertRepetition( "NTE", structure, rep);
382 }
383
384
385 /**
386 * <p>
387 * Inserts a specific repetition of NTE (Notes and Comments)
388 * </p>
389 *
390 *
391 * @see AbstractGroup#insertRepetition(Structure, int)
392 */
393 public NTE insertNTE(int rep) throws HL7Exception {
394 return (NTE)super.insertRepetition("NTE", rep);
395 }
396
397
398 /**
399 * <p>
400 * Removes a specific repetition of NTE (Notes and Comments)
401 * </p>
402 *
403 *
404 * @see AbstractGroup#removeRepetition(String, int)
405 */
406 public NTE removeNTE(int rep) throws HL7Exception {
407 return (NTE)super.removeRepetition("NTE", rep);
408 }
409
410
411
412
413 /**
414 * <p>
415 * Returns
416 * RESPONSE (a Group object) - creates it if necessary
417 * </p>
418 *
419 *
420 */
421 public BRP_O30_RESPONSE getRESPONSE() {
422 return getTyped("RESPONSE", BRP_O30_RESPONSE.class);
423 }
424
425
426
427
428 }
429