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.group;
35
36 import ca.uhn.hl7v2.model.v25.segment.*;
37
38 import ca.uhn.hl7v2.HL7Exception;
39 import ca.uhn.hl7v2.parser.ModelClassFactory;
40 import ca.uhn.hl7v2.model.*;
41
42 /**
43 * <p>Represents a MFR_M05_MF_QUERY group structure (a Group object).
44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45 * This Group contains the following elements:
46 * </p>
47 * <ul>
48 * <li>1: MFE (Master File Entry) <b> </b></li>
49 * <li>2: LOC (Location Identification) <b> </b></li>
50 * <li>3: LCH (Location Characteristic) <b>optional repeating </b></li>
51 * <li>4: LRL (Location Relationship) <b>optional repeating </b></li>
52 * <li>5: LDP (Location Department) <b> repeating </b></li>
53 * <li>6: LCH (Location Characteristic) <b>optional repeating </b></li>
54 * <li>7: LCC (Location Charge Code) <b>optional repeating </b></li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class MFR_M05_MF_QUERY extends AbstractGroup {
59
60 /**
61 * Creates a new MFR_M05_MF_QUERY group
62 */
63 public MFR_M05_MF_QUERY(Group parent, ModelClassFactory factory) {
64 super(parent, factory);
65 init(factory);
66 }
67
68 private void init(ModelClassFactory factory) {
69 try {
70 this.add(MFE.class, true, false, false);
71 this.add(LOC.class, true, false, false);
72 this.add(LCH.class, false, true, false);
73 this.add(LRL.class, false, true, false);
74 this.add(LDP.class, true, true, false);
75 this.add(LCH.class, false, true, false);
76 this.add(LCC.class, false, true, false);
77 } catch(HL7Exception e) {
78 log.error("Unexpected error creating MFR_M05_MF_QUERY - this is probably a bug in the source code generator.", e);
79 }
80 }
81
82 /**
83 * Returns "2.5"
84 */
85 public String getVersion() {
86 return "2.5";
87 }
88
89
90
91 /**
92 * Returns
93 * MFE (Master File Entry) - creates it if necessary
94 */
95 public MFE getMFE() {
96 MFE retVal = getTyped("MFE", MFE.class);
97 return retVal;
98 }
99
100
101
102
103 /**
104 * Returns
105 * LOC (Location Identification) - creates it if necessary
106 */
107 public LOC getLOC() {
108 LOC retVal = getTyped("LOC", LOC.class);
109 return retVal;
110 }
111
112
113
114
115 /**
116 * Returns
117 * the first repetition of
118 * LCH (Location Characteristic) - creates it if necessary
119 */
120 public LCH getLCH() {
121 LCH retVal = getTyped("LCH", LCH.class);
122 return retVal;
123 }
124
125
126 /**
127 * Returns a specific repetition of
128 * LCH (Location Characteristic) - creates it if necessary
129 *
130 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
131 * @throws HL7Exception if the repetition requested is more than one
132 * greater than the number of existing repetitions.
133 */
134 public LCH getLCH(int rep) {
135 LCH retVal = getTyped("LCH", rep, LCH.class);
136 return retVal;
137 }
138
139 /**
140 * Returns the number of existing repetitions of LCH
141 */
142 public int getLCHReps() {
143 return getReps("LCH");
144 }
145
146 /**
147 * <p>
148 * Returns a non-modifiable List containing all current existing repetitions of LCH.
149 * <p>
150 * <p>
151 * Note that unlike {@link #getLCH()}, this method will not create any reps
152 * if none are already present, so an empty list may be returned.
153 * </p>
154 */
155 public java.util.List<LCH> getLCHAll() throws HL7Exception {
156 return getAllAsList("LCH", LCH.class);
157 }
158
159 /**
160 * Inserts a specific repetition of LCH (Location Characteristic)
161 * @see AbstractGroup#insertRepetition(Structure, int)
162 */
163 public void insertLCH(LCH structure, int rep) throws HL7Exception {
164 super.insertRepetition("LCH", structure, rep);
165 }
166
167
168 /**
169 * Inserts a specific repetition of LCH (Location Characteristic)
170 * @see AbstractGroup#insertRepetition(Structure, int)
171 */
172 public LCH insertLCH(int rep) throws HL7Exception {
173 return (LCH)super.insertRepetition("LCH", rep);
174 }
175
176
177 /**
178 * Removes a specific repetition of LCH (Location Characteristic)
179 * @see AbstractGroup#removeRepetition(String, int)
180 */
181 public LCH removeLCH(int rep) throws HL7Exception {
182 return (LCH)super.removeRepetition("LCH", rep);
183 }
184
185
186
187 /**
188 * Returns
189 * the first repetition of
190 * LRL (Location Relationship) - creates it if necessary
191 */
192 public LRL getLRL() {
193 LRL retVal = getTyped("LRL", LRL.class);
194 return retVal;
195 }
196
197
198 /**
199 * Returns a specific repetition of
200 * LRL (Location Relationship) - creates it if necessary
201 *
202 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
203 * @throws HL7Exception if the repetition requested is more than one
204 * greater than the number of existing repetitions.
205 */
206 public LRL getLRL(int rep) {
207 LRL retVal = getTyped("LRL", rep, LRL.class);
208 return retVal;
209 }
210
211 /**
212 * Returns the number of existing repetitions of LRL
213 */
214 public int getLRLReps() {
215 return getReps("LRL");
216 }
217
218 /**
219 * <p>
220 * Returns a non-modifiable List containing all current existing repetitions of LRL.
221 * <p>
222 * <p>
223 * Note that unlike {@link #getLRL()}, this method will not create any reps
224 * if none are already present, so an empty list may be returned.
225 * </p>
226 */
227 public java.util.List<LRL> getLRLAll() throws HL7Exception {
228 return getAllAsList("LRL", LRL.class);
229 }
230
231 /**
232 * Inserts a specific repetition of LRL (Location Relationship)
233 * @see AbstractGroup#insertRepetition(Structure, int)
234 */
235 public void insertLRL(LRL structure, int rep) throws HL7Exception {
236 super.insertRepetition("LRL", structure, rep);
237 }
238
239
240 /**
241 * Inserts a specific repetition of LRL (Location Relationship)
242 * @see AbstractGroup#insertRepetition(Structure, int)
243 */
244 public LRL insertLRL(int rep) throws HL7Exception {
245 return (LRL)super.insertRepetition("LRL", rep);
246 }
247
248
249 /**
250 * Removes a specific repetition of LRL (Location Relationship)
251 * @see AbstractGroup#removeRepetition(String, int)
252 */
253 public LRL removeLRL(int rep) throws HL7Exception {
254 return (LRL)super.removeRepetition("LRL", rep);
255 }
256
257
258
259 /**
260 * Returns
261 * the first repetition of
262 * LDP (Location Department) - creates it if necessary
263 */
264 public LDP getLDP() {
265 LDP retVal = getTyped("LDP", LDP.class);
266 return retVal;
267 }
268
269
270 /**
271 * Returns a specific repetition of
272 * LDP (Location Department) - creates it if necessary
273 *
274 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
275 * @throws HL7Exception if the repetition requested is more than one
276 * greater than the number of existing repetitions.
277 */
278 public LDP getLDP(int rep) {
279 LDP retVal = getTyped("LDP", rep, LDP.class);
280 return retVal;
281 }
282
283 /**
284 * Returns the number of existing repetitions of LDP
285 */
286 public int getLDPReps() {
287 return getReps("LDP");
288 }
289
290 /**
291 * <p>
292 * Returns a non-modifiable List containing all current existing repetitions of LDP.
293 * <p>
294 * <p>
295 * Note that unlike {@link #getLDP()}, this method will not create any reps
296 * if none are already present, so an empty list may be returned.
297 * </p>
298 */
299 public java.util.List<LDP> getLDPAll() throws HL7Exception {
300 return getAllAsList("LDP", LDP.class);
301 }
302
303 /**
304 * Inserts a specific repetition of LDP (Location Department)
305 * @see AbstractGroup#insertRepetition(Structure, int)
306 */
307 public void insertLDP(LDP structure, int rep) throws HL7Exception {
308 super.insertRepetition("LDP", structure, rep);
309 }
310
311
312 /**
313 * Inserts a specific repetition of LDP (Location Department)
314 * @see AbstractGroup#insertRepetition(Structure, int)
315 */
316 public LDP insertLDP(int rep) throws HL7Exception {
317 return (LDP)super.insertRepetition("LDP", rep);
318 }
319
320
321 /**
322 * Removes a specific repetition of LDP (Location Department)
323 * @see AbstractGroup#removeRepetition(String, int)
324 */
325 public LDP removeLDP(int rep) throws HL7Exception {
326 return (LDP)super.removeRepetition("LDP", rep);
327 }
328
329
330
331 /**
332 * Returns
333 * the first repetition of
334 * LCH2 (Location Characteristic) - creates it if necessary
335 */
336 public LCH getLCH2() {
337 LCH retVal = getTyped("LCH2", LCH.class);
338 return retVal;
339 }
340
341
342 /**
343 * Returns a specific repetition of
344 * LCH (Location Characteristic) - creates it if necessary
345 *
346 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
347 * @throws HL7Exception if the repetition requested is more than one
348 * greater than the number of existing repetitions.
349 */
350 public LCH getLCH2(int rep) {
351 LCH retVal = getTyped("LCH2", rep, LCH.class);
352 return retVal;
353 }
354
355 /**
356 * Returns the number of existing repetitions of LCH2
357 */
358 public int getLCH2Reps() {
359 return getReps("LCH2");
360 }
361
362 /**
363 * <p>
364 * Returns a non-modifiable List containing all current existing repetitions of LCH2.
365 * <p>
366 * <p>
367 * Note that unlike {@link #getLCH2()}, this method will not create any reps
368 * if none are already present, so an empty list may be returned.
369 * </p>
370 */
371 public java.util.List<LCH> getLCH2All() throws HL7Exception {
372 return getAllAsList("LCH2", LCH.class);
373 }
374
375 /**
376 * Inserts a specific repetition of LCH2 (Location Characteristic)
377 * @see AbstractGroup#insertRepetition(Structure, int)
378 */
379 public void insertLCH2(LCH structure, int rep) throws HL7Exception {
380 super.insertRepetition("LCH2", structure, rep);
381 }
382
383
384 /**
385 * Inserts a specific repetition of LCH2 (Location Characteristic)
386 * @see AbstractGroup#insertRepetition(Structure, int)
387 */
388 public LCH insertLCH2(int rep) throws HL7Exception {
389 return (LCH)super.insertRepetition("LCH2", rep);
390 }
391
392
393 /**
394 * Removes a specific repetition of LCH2 (Location Characteristic)
395 * @see AbstractGroup#removeRepetition(String, int)
396 */
397 public LCH removeLCH2(int rep) throws HL7Exception {
398 return (LCH)super.removeRepetition("LCH2", rep);
399 }
400
401
402
403 /**
404 * Returns
405 * the first repetition of
406 * LCC (Location Charge Code) - creates it if necessary
407 */
408 public LCC getLCC() {
409 LCC retVal = getTyped("LCC", LCC.class);
410 return retVal;
411 }
412
413
414 /**
415 * Returns a specific repetition of
416 * LCC (Location Charge Code) - creates it if necessary
417 *
418 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
419 * @throws HL7Exception if the repetition requested is more than one
420 * greater than the number of existing repetitions.
421 */
422 public LCC getLCC(int rep) {
423 LCC retVal = getTyped("LCC", rep, LCC.class);
424 return retVal;
425 }
426
427 /**
428 * Returns the number of existing repetitions of LCC
429 */
430 public int getLCCReps() {
431 return getReps("LCC");
432 }
433
434 /**
435 * <p>
436 * Returns a non-modifiable List containing all current existing repetitions of LCC.
437 * <p>
438 * <p>
439 * Note that unlike {@link #getLCC()}, this method will not create any reps
440 * if none are already present, so an empty list may be returned.
441 * </p>
442 */
443 public java.util.List<LCC> getLCCAll() throws HL7Exception {
444 return getAllAsList("LCC", LCC.class);
445 }
446
447 /**
448 * Inserts a specific repetition of LCC (Location Charge Code)
449 * @see AbstractGroup#insertRepetition(Structure, int)
450 */
451 public void insertLCC(LCC structure, int rep) throws HL7Exception {
452 super.insertRepetition("LCC", structure, rep);
453 }
454
455
456 /**
457 * Inserts a specific repetition of LCC (Location Charge Code)
458 * @see AbstractGroup#insertRepetition(Structure, int)
459 */
460 public LCC insertLCC(int rep) throws HL7Exception {
461 return (LCC)super.insertRepetition("LCC", rep);
462 }
463
464
465 /**
466 * Removes a specific repetition of LCC (Location Charge Code)
467 * @see AbstractGroup#removeRepetition(String, int)
468 */
469 public LCC removeLCC(int rep) throws HL7Exception {
470 return (LCC)super.removeRepetition("LCC", rep);
471 }
472
473
474
475 }
476