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