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