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_Z86 message structure (see chapter 5.9.1.2.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: RSP_Z86_QUERY_RESPONSE (a Group object) <b> repeating</b> </li>
56 * <li>8: DSC (Continuation Pointer) <b>optional </b> </li>
57 * </ul>
58 */
59 //@SuppressWarnings("unused")
60 public class RSP_Z86 extends AbstractMessage {
61
62 /**
63 * Creates a new RSP_Z86 message with DefaultModelClassFactory.
64 */
65 public RSP_Z86() {
66 this(new DefaultModelClassFactory());
67 }
68
69 /**
70 * Creates a new RSP_Z86 message with custom ModelClassFactory.
71 */
72 public RSP_Z86(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(MSA.class, true, false);
82 this.add(ERR.class, false, false);
83 this.add(QAK.class, true, false);
84 this.add(QPD.class, true, false);
85 this.add(RSP_Z86_QUERY_RESPONSE.class, true, true);
86 this.add(DSC.class, false, false);
87 } catch(HL7Exception e) {
88 log.error("Unexpected error creating RSP_Z86 - this is probably a bug in the source code generator.", e);
89 }
90 }
91
92
93 /**
94 * Returns "2.5"
95 */
96 public String getVersion() {
97 return "2.5";
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 * MSA (Message Acknowledgment) - creates it if necessary
217 * </p>
218 *
219 *
220 */
221 public MSA getMSA() {
222 return getTyped("MSA", MSA.class);
223 }
224
225
226
227
228
229 /**
230 * <p>
231 * Returns
232 * ERR (Error) - creates it if necessary
233 * </p>
234 *
235 *
236 */
237 public ERR getERR() {
238 return getTyped("ERR", ERR.class);
239 }
240
241
242
243
244
245 /**
246 * <p>
247 * Returns
248 * QAK (Query Acknowledgment) - creates it if necessary
249 * </p>
250 *
251 *
252 */
253 public QAK getQAK() {
254 return getTyped("QAK", QAK.class);
255 }
256
257
258
259
260
261 /**
262 * <p>
263 * Returns
264 * QPD (Query Parameter Definition) - creates it if necessary
265 * </p>
266 *
267 *
268 */
269 public QPD getQPD() {
270 return getTyped("QPD", QPD.class);
271 }
272
273
274
275
276
277 /**
278 * <p>
279 * Returns
280 * the first repetition of
281 * QUERY_RESPONSE (a Group object) - creates it if necessary
282 * </p>
283 *
284 *
285 */
286 public RSP_Z86_QUERY_RESPONSE getQUERY_RESPONSE() {
287 return getTyped("QUERY_RESPONSE", RSP_Z86_QUERY_RESPONSE.class);
288 }
289
290
291 /**
292 * <p>
293 * Returns a specific repetition of
294 * QUERY_RESPONSE (a Group object) - creates it if necessary
295 * </p>
296 *
297 *
298 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
299 * @throws HL7Exception if the repetition requested is more than one
300 * greater than the number of existing repetitions.
301 */
302 public RSP_Z86_QUERY_RESPONSE getQUERY_RESPONSE(int rep) {
303 return getTyped("QUERY_RESPONSE", rep, RSP_Z86_QUERY_RESPONSE.class);
304 }
305
306 /**
307 * <p>
308 * Returns the number of existing repetitions of QUERY_RESPONSE
309 * </p>
310 *
311 */
312 public int getQUERY_RESPONSEReps() {
313 return getReps("QUERY_RESPONSE");
314 }
315
316 /**
317 * <p>
318 * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
319 * <p>
320 * <p>
321 * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps
322 * if none are already present, so an empty list may be returned.
323 * </p>
324 *
325 */
326 public java.util.List<RSP_Z86_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception {
327 return getAllAsList("QUERY_RESPONSE", RSP_Z86_QUERY_RESPONSE.class);
328 }
329
330 /**
331 * <p>
332 * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
333 * </p>
334 *
335 *
336 * @see AbstractGroup#insertRepetition(Structure, int)
337 */
338 public void insertQUERY_RESPONSE(RSP_Z86_QUERY_RESPONSE structure, int rep) throws HL7Exception {
339 super.insertRepetition( "QUERY_RESPONSE", structure, rep);
340 }
341
342
343 /**
344 * <p>
345 * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
346 * </p>
347 *
348 *
349 * @see AbstractGroup#insertRepetition(Structure, int)
350 */
351 public RSP_Z86_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception {
352 return (RSP_Z86_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep);
353 }
354
355
356 /**
357 * <p>
358 * Removes a specific repetition of QUERY_RESPONSE (a Group object)
359 * </p>
360 *
361 *
362 * @see AbstractGroup#removeRepetition(String, int)
363 */
364 public RSP_Z86_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception {
365 return (RSP_Z86_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep);
366 }
367
368
369
370
371 /**
372 * <p>
373 * Returns
374 * DSC (Continuation Pointer) - creates it if necessary
375 * </p>
376 *
377 *
378 */
379 public DSC getDSC() {
380 return getTyped("DSC", DSC.class);
381 }
382
383
384
385
386 }
387