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