001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v27.message;
035
036import ca.uhn.hl7v2.model.v27.group.*;
037import ca.uhn.hl7v2.model.v27.segment.*;
038
039import ca.uhn.hl7v2.HL7Exception;
040import ca.uhn.hl7v2.parser.ModelClassFactory;
041import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044
045/**
046 * <p>Represents a EHC_E24 message structure (see chapter 16.3.14). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (Message Header) <b> </b> </li>
050                                 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li>
051                                 * <li>3: UAC (User Authentication Credential Segment) <b>optional repeating</b> </li>
052                                 * <li>4: MSA (Message Acknowledgment) <b> </b> </li>
053                                 * <li>5: ERR (Error) <b>optional repeating</b> </li>
054                                 * <li>6: IVC (Invoice Segment) <b> </b> </li>
055                                 * <li>7: EHC_E24_PSL_ITEM_INFO (a Group object) <b> repeating</b> </li>
056 * </ul>
057 */
058//@SuppressWarnings("unused")
059public class EHC_E24 extends AbstractMessage  {
060
061    /**
062     * Creates a new EHC_E24 message with DefaultModelClassFactory. 
063     */ 
064    public EHC_E24() { 
065       this(new DefaultModelClassFactory());
066    }
067
068    /** 
069     * Creates a new EHC_E24 message with custom ModelClassFactory.
070     */
071    public EHC_E24(ModelClassFactory factory) {
072       super(factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                          this.add(MSH.class, true, false);
079                                  this.add(SFT.class, false, true);
080                                  this.add(UAC.class, false, true);
081                                  this.add(MSA.class, true, false);
082                                  this.add(ERR.class, false, true);
083                                  this.add(IVC.class, true, false);
084                                  this.add(EHC_E24_PSL_ITEM_INFO.class, true, true);
085               } catch(HL7Exception e) {
086          log.error("Unexpected error creating EHC_E24 - this is probably a bug in the source code generator.", e);
087       }
088    }
089
090
091    /** 
092     * Returns "2.7"
093     */
094    public String getVersion() {
095       return "2.7";
096    }
097
098
099
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     * the first repetition of 
121     * SFT (Software Segment) - creates it if necessary
122     * </p>
123     * 
124     *
125     */
126    public SFT getSFT() { 
127       return getTyped("SFT", SFT.class);
128    }
129
130
131    /**
132     * <p>
133     * Returns a specific repetition of
134     * SFT (Software Segment) - creates it if necessary
135     * </p>
136     * 
137     *
138     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
139     * @throws HL7Exception if the repetition requested is more than one 
140     *     greater than the number of existing repetitions.
141     */
142    public SFT getSFT(int rep) { 
143       return getTyped("SFT", rep, SFT.class);
144    }
145
146    /** 
147     * <p>
148     * Returns the number of existing repetitions of SFT 
149     * </p>
150     * 
151     */ 
152    public int getSFTReps() { 
153        return getReps("SFT");
154    } 
155
156    /** 
157     * <p>
158     * Returns a non-modifiable List containing all current existing repetitions of SFT.
159     * <p>
160     * <p>
161     * Note that unlike {@link #getSFT()}, this method will not create any reps
162     * if none are already present, so an empty list may be returned.
163     * </p>
164     * 
165     */ 
166    public java.util.List<SFT> getSFTAll() throws HL7Exception {
167        return getAllAsList("SFT", SFT.class);
168    } 
169
170    /**
171     * <p>
172     * Inserts a specific repetition of SFT (Software Segment)
173     * </p>
174     * 
175     *
176     * @see AbstractGroup#insertRepetition(Structure, int) 
177     */
178    public void insertSFT(SFT structure, int rep) throws HL7Exception { 
179       super.insertRepetition( "SFT", structure, rep);
180    }
181
182
183    /**
184     * <p>
185     * Inserts a specific repetition of SFT (Software Segment)
186     * </p>
187     * 
188     *
189     * @see AbstractGroup#insertRepetition(Structure, int) 
190     */
191    public SFT insertSFT(int rep) throws HL7Exception { 
192       return (SFT)super.insertRepetition("SFT", rep);
193    }
194
195
196    /**
197     * <p>
198     * Removes a specific repetition of SFT (Software Segment)
199     * </p>
200     * 
201     *
202     * @see AbstractGroup#removeRepetition(String, int) 
203     */
204    public SFT removeSFT(int rep) throws HL7Exception { 
205       return (SFT)super.removeRepetition("SFT", rep);
206    }
207
208
209
210
211    /**
212     * <p>
213     * Returns
214     * the first repetition of 
215     * UAC (User Authentication Credential Segment) - creates it if necessary
216     * </p>
217     * 
218     *
219     */
220    public UAC getUAC() { 
221       return getTyped("UAC", UAC.class);
222    }
223
224
225    /**
226     * <p>
227     * Returns a specific repetition of
228     * UAC (User Authentication Credential Segment) - creates it if necessary
229     * </p>
230     * 
231     *
232     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
233     * @throws HL7Exception if the repetition requested is more than one 
234     *     greater than the number of existing repetitions.
235     */
236    public UAC getUAC(int rep) { 
237       return getTyped("UAC", rep, UAC.class);
238    }
239
240    /** 
241     * <p>
242     * Returns the number of existing repetitions of UAC 
243     * </p>
244     * 
245     */ 
246    public int getUACReps() { 
247        return getReps("UAC");
248    } 
249
250    /** 
251     * <p>
252     * Returns a non-modifiable List containing all current existing repetitions of UAC.
253     * <p>
254     * <p>
255     * Note that unlike {@link #getUAC()}, this method will not create any reps
256     * if none are already present, so an empty list may be returned.
257     * </p>
258     * 
259     */ 
260    public java.util.List<UAC> getUACAll() throws HL7Exception {
261        return getAllAsList("UAC", UAC.class);
262    } 
263
264    /**
265     * <p>
266     * Inserts a specific repetition of UAC (User Authentication Credential Segment)
267     * </p>
268     * 
269     *
270     * @see AbstractGroup#insertRepetition(Structure, int) 
271     */
272    public void insertUAC(UAC structure, int rep) throws HL7Exception { 
273       super.insertRepetition( "UAC", structure, rep);
274    }
275
276
277    /**
278     * <p>
279     * Inserts a specific repetition of UAC (User Authentication Credential Segment)
280     * </p>
281     * 
282     *
283     * @see AbstractGroup#insertRepetition(Structure, int) 
284     */
285    public UAC insertUAC(int rep) throws HL7Exception { 
286       return (UAC)super.insertRepetition("UAC", rep);
287    }
288
289
290    /**
291     * <p>
292     * Removes a specific repetition of UAC (User Authentication Credential Segment)
293     * </p>
294     * 
295     *
296     * @see AbstractGroup#removeRepetition(String, int) 
297     */
298    public UAC removeUAC(int rep) throws HL7Exception { 
299       return (UAC)super.removeRepetition("UAC", rep);
300    }
301
302
303
304
305    /**
306     * <p>
307     * Returns
308     * MSA (Message Acknowledgment) - creates it if necessary
309     * </p>
310     * 
311     *
312     */
313    public MSA getMSA() { 
314       return getTyped("MSA", MSA.class);
315    }
316
317
318
319
320
321    /**
322     * <p>
323     * Returns
324     * the first repetition of 
325     * ERR (Error) - creates it if necessary
326     * </p>
327     * 
328     *
329     */
330    public ERR getERR() { 
331       return getTyped("ERR", ERR.class);
332    }
333
334
335    /**
336     * <p>
337     * Returns a specific repetition of
338     * ERR (Error) - creates it if necessary
339     * </p>
340     * 
341     *
342     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
343     * @throws HL7Exception if the repetition requested is more than one 
344     *     greater than the number of existing repetitions.
345     */
346    public ERR getERR(int rep) { 
347       return getTyped("ERR", rep, ERR.class);
348    }
349
350    /** 
351     * <p>
352     * Returns the number of existing repetitions of ERR 
353     * </p>
354     * 
355     */ 
356    public int getERRReps() { 
357        return getReps("ERR");
358    } 
359
360    /** 
361     * <p>
362     * Returns a non-modifiable List containing all current existing repetitions of ERR.
363     * <p>
364     * <p>
365     * Note that unlike {@link #getERR()}, this method will not create any reps
366     * if none are already present, so an empty list may be returned.
367     * </p>
368     * 
369     */ 
370    public java.util.List<ERR> getERRAll() throws HL7Exception {
371        return getAllAsList("ERR", ERR.class);
372    } 
373
374    /**
375     * <p>
376     * Inserts a specific repetition of ERR (Error)
377     * </p>
378     * 
379     *
380     * @see AbstractGroup#insertRepetition(Structure, int) 
381     */
382    public void insertERR(ERR structure, int rep) throws HL7Exception { 
383       super.insertRepetition( "ERR", structure, rep);
384    }
385
386
387    /**
388     * <p>
389     * Inserts a specific repetition of ERR (Error)
390     * </p>
391     * 
392     *
393     * @see AbstractGroup#insertRepetition(Structure, int) 
394     */
395    public ERR insertERR(int rep) throws HL7Exception { 
396       return (ERR)super.insertRepetition("ERR", rep);
397    }
398
399
400    /**
401     * <p>
402     * Removes a specific repetition of ERR (Error)
403     * </p>
404     * 
405     *
406     * @see AbstractGroup#removeRepetition(String, int) 
407     */
408    public ERR removeERR(int rep) throws HL7Exception { 
409       return (ERR)super.removeRepetition("ERR", rep);
410    }
411
412
413
414
415    /**
416     * <p>
417     * Returns
418     * IVC (Invoice Segment) - creates it if necessary
419     * </p>
420     * 
421     *
422     */
423    public IVC getIVC() { 
424       return getTyped("IVC", IVC.class);
425    }
426
427
428
429
430
431    /**
432     * <p>
433     * Returns
434     * the first repetition of 
435     * PSL_ITEM_INFO (a Group object) - creates it if necessary
436     * </p>
437     * 
438     *
439     */
440    public EHC_E24_PSL_ITEM_INFO getPSL_ITEM_INFO() { 
441       return getTyped("PSL_ITEM_INFO", EHC_E24_PSL_ITEM_INFO.class);
442    }
443
444
445    /**
446     * <p>
447     * Returns a specific repetition of
448     * PSL_ITEM_INFO (a Group object) - creates it if necessary
449     * </p>
450     * 
451     *
452     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
453     * @throws HL7Exception if the repetition requested is more than one 
454     *     greater than the number of existing repetitions.
455     */
456    public EHC_E24_PSL_ITEM_INFO getPSL_ITEM_INFO(int rep) { 
457       return getTyped("PSL_ITEM_INFO", rep, EHC_E24_PSL_ITEM_INFO.class);
458    }
459
460    /** 
461     * <p>
462     * Returns the number of existing repetitions of PSL_ITEM_INFO 
463     * </p>
464     * 
465     */ 
466    public int getPSL_ITEM_INFOReps() { 
467        return getReps("PSL_ITEM_INFO");
468    } 
469
470    /** 
471     * <p>
472     * Returns a non-modifiable List containing all current existing repetitions of PSL_ITEM_INFO.
473     * <p>
474     * <p>
475     * Note that unlike {@link #getPSL_ITEM_INFO()}, this method will not create any reps
476     * if none are already present, so an empty list may be returned.
477     * </p>
478     * 
479     */ 
480    public java.util.List<EHC_E24_PSL_ITEM_INFO> getPSL_ITEM_INFOAll() throws HL7Exception {
481        return getAllAsList("PSL_ITEM_INFO", EHC_E24_PSL_ITEM_INFO.class);
482    } 
483
484    /**
485     * <p>
486     * Inserts a specific repetition of PSL_ITEM_INFO (a Group object)
487     * </p>
488     * 
489     *
490     * @see AbstractGroup#insertRepetition(Structure, int) 
491     */
492    public void insertPSL_ITEM_INFO(EHC_E24_PSL_ITEM_INFO structure, int rep) throws HL7Exception { 
493       super.insertRepetition( "PSL_ITEM_INFO", structure, rep);
494    }
495
496
497    /**
498     * <p>
499     * Inserts a specific repetition of PSL_ITEM_INFO (a Group object)
500     * </p>
501     * 
502     *
503     * @see AbstractGroup#insertRepetition(Structure, int) 
504     */
505    public EHC_E24_PSL_ITEM_INFO insertPSL_ITEM_INFO(int rep) throws HL7Exception { 
506       return (EHC_E24_PSL_ITEM_INFO)super.insertRepetition("PSL_ITEM_INFO", rep);
507    }
508
509
510    /**
511     * <p>
512     * Removes a specific repetition of PSL_ITEM_INFO (a Group object)
513     * </p>
514     * 
515     *
516     * @see AbstractGroup#removeRepetition(String, int) 
517     */
518    public EHC_E24_PSL_ITEM_INFO removePSL_ITEM_INFO(int rep) throws HL7Exception { 
519       return (EHC_E24_PSL_ITEM_INFO)super.removeRepetition("PSL_ITEM_INFO", rep);
520    }
521
522
523
524}
525