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