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.v28.group;
035
036import ca.uhn.hl7v2.model.v28.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a ADT_A05_INSURANCE group structure (a Group object).
044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
045 * This Group contains the following elements:  
046 * </p>
047 * <ul>
048                         * <li>1: IN1 (Insurance) <b>  </b></li>
049                         * <li>2: IN2 (Insurance Additional Information) <b>optional  </b></li>
050                         * <li>3: IN3 (Insurance Additional Information, Certification) <b>optional repeating </b></li>
051                         * <li>4: ROL (Role) <b>optional repeating </b></li>
052                         * <li>5: AUT (Authorization Information) <b>optional repeating </b></li>
053                         * <li>6: RF1 (Referral Information) <b>optional repeating </b></li>
054 * </ul>
055 */
056//@SuppressWarnings("unused")
057public class ADT_A05_INSURANCE extends AbstractGroup {
058
059    /** 
060     * Creates a new ADT_A05_INSURANCE group
061     */
062    public ADT_A05_INSURANCE(Group parent, ModelClassFactory factory) {
063       super(parent, factory);
064       init(factory);
065    }
066
067    private void init(ModelClassFactory factory) {
068       try {
069                                  this.add(IN1.class, true, false, false);
070                                  this.add(IN2.class, false, false, false);
071                                  this.add(IN3.class, false, true, false);
072                                  this.add(ROL.class, false, true, false);
073                                  this.add(AUT.class, false, true, false);
074                                  this.add(RF1.class, false, true, false);
075       } catch(HL7Exception e) {
076          log.error("Unexpected error creating ADT_A05_INSURANCE - this is probably a bug in the source code generator.", e);
077       }
078    }
079
080    /** 
081     * Returns "2.8"
082     */
083    public String getVersion() {
084       return "2.8";
085    }
086
087
088
089    /**
090     * Returns
091     * IN1 (Insurance) - creates it if necessary
092     */
093    public IN1 getIN1() { 
094       IN1 retVal = getTyped("IN1", IN1.class);
095       return retVal;
096    }
097
098
099
100
101    /**
102     * Returns
103     * IN2 (Insurance Additional Information) - creates it if necessary
104     */
105    public IN2 getIN2() { 
106       IN2 retVal = getTyped("IN2", IN2.class);
107       return retVal;
108    }
109
110
111
112
113    /**
114     * Returns
115     * the first repetition of 
116     * IN3 (Insurance Additional Information, Certification) - creates it if necessary
117     */
118    public IN3 getIN3() { 
119       IN3 retVal = getTyped("IN3", IN3.class);
120       return retVal;
121    }
122
123
124    /**
125     * Returns a specific repetition of
126     * IN3 (Insurance Additional Information, Certification) - creates it if necessary
127     *
128     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129     * @throws HL7Exception if the repetition requested is more than one 
130     *     greater than the number of existing repetitions.
131     */
132    public IN3 getIN3(int rep) { 
133       IN3 retVal = getTyped("IN3", rep, IN3.class);
134       return retVal;
135    }
136
137    /** 
138     * Returns the number of existing repetitions of IN3 
139     */ 
140    public int getIN3Reps() {  
141        return getReps("IN3");
142    } 
143
144    /** 
145     * <p>
146     * Returns a non-modifiable List containing all current existing repetitions of IN3.
147     * <p>
148     * <p>
149     * Note that unlike {@link #getIN3()}, this method will not create any reps
150     * if none are already present, so an empty list may be returned.
151     * </p>
152     */ 
153    public java.util.List<IN3> getIN3All() throws HL7Exception {
154        return getAllAsList("IN3", IN3.class);
155    } 
156
157    /**
158     * Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)
159     * @see AbstractGroup#insertRepetition(Structure, int) 
160     */
161    public void insertIN3(IN3 structure, int rep) throws HL7Exception { 
162       super.insertRepetition("IN3", structure, rep);
163    }
164
165
166    /**
167     * Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)
168     * @see AbstractGroup#insertRepetition(Structure, int) 
169     */
170    public IN3 insertIN3(int rep) throws HL7Exception { 
171       return (IN3)super.insertRepetition("IN3", rep);
172    }
173
174
175    /**
176     * Removes a specific repetition of IN3 (Insurance Additional Information, Certification)
177     * @see AbstractGroup#removeRepetition(String, int) 
178     */
179    public IN3 removeIN3(int rep) throws HL7Exception { 
180       return (IN3)super.removeRepetition("IN3", rep);
181    }
182
183
184
185    /**
186     * Returns
187     * the first repetition of 
188     * ROL (Role) - creates it if necessary
189     */
190    public ROL getROL() { 
191       ROL retVal = getTyped("ROL", ROL.class);
192       return retVal;
193    }
194
195
196    /**
197     * Returns a specific repetition of
198     * ROL (Role) - creates it if necessary
199     *
200     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
201     * @throws HL7Exception if the repetition requested is more than one 
202     *     greater than the number of existing repetitions.
203     */
204    public ROL getROL(int rep) { 
205       ROL retVal = getTyped("ROL", rep, ROL.class);
206       return retVal;
207    }
208
209    /** 
210     * Returns the number of existing repetitions of ROL 
211     */ 
212    public int getROLReps() {  
213        return getReps("ROL");
214    } 
215
216    /** 
217     * <p>
218     * Returns a non-modifiable List containing all current existing repetitions of ROL.
219     * <p>
220     * <p>
221     * Note that unlike {@link #getROL()}, this method will not create any reps
222     * if none are already present, so an empty list may be returned.
223     * </p>
224     */ 
225    public java.util.List<ROL> getROLAll() throws HL7Exception {
226        return getAllAsList("ROL", ROL.class);
227    } 
228
229    /**
230     * Inserts a specific repetition of ROL (Role)
231     * @see AbstractGroup#insertRepetition(Structure, int) 
232     */
233    public void insertROL(ROL structure, int rep) throws HL7Exception { 
234       super.insertRepetition("ROL", structure, rep);
235    }
236
237
238    /**
239     * Inserts a specific repetition of ROL (Role)
240     * @see AbstractGroup#insertRepetition(Structure, int) 
241     */
242    public ROL insertROL(int rep) throws HL7Exception { 
243       return (ROL)super.insertRepetition("ROL", rep);
244    }
245
246
247    /**
248     * Removes a specific repetition of ROL (Role)
249     * @see AbstractGroup#removeRepetition(String, int) 
250     */
251    public ROL removeROL(int rep) throws HL7Exception { 
252       return (ROL)super.removeRepetition("ROL", rep);
253    }
254
255
256
257    /**
258     * Returns
259     * the first repetition of 
260     * AUT (Authorization Information) - creates it if necessary
261     */
262    public AUT getAUT() { 
263       AUT retVal = getTyped("AUT", AUT.class);
264       return retVal;
265    }
266
267
268    /**
269     * Returns a specific repetition of
270     * AUT (Authorization Information) - creates it if necessary
271     *
272     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
273     * @throws HL7Exception if the repetition requested is more than one 
274     *     greater than the number of existing repetitions.
275     */
276    public AUT getAUT(int rep) { 
277       AUT retVal = getTyped("AUT", rep, AUT.class);
278       return retVal;
279    }
280
281    /** 
282     * Returns the number of existing repetitions of AUT 
283     */ 
284    public int getAUTReps() {  
285        return getReps("AUT");
286    } 
287
288    /** 
289     * <p>
290     * Returns a non-modifiable List containing all current existing repetitions of AUT.
291     * <p>
292     * <p>
293     * Note that unlike {@link #getAUT()}, this method will not create any reps
294     * if none are already present, so an empty list may be returned.
295     * </p>
296     */ 
297    public java.util.List<AUT> getAUTAll() throws HL7Exception {
298        return getAllAsList("AUT", AUT.class);
299    } 
300
301    /**
302     * Inserts a specific repetition of AUT (Authorization Information)
303     * @see AbstractGroup#insertRepetition(Structure, int) 
304     */
305    public void insertAUT(AUT structure, int rep) throws HL7Exception { 
306       super.insertRepetition("AUT", structure, rep);
307    }
308
309
310    /**
311     * Inserts a specific repetition of AUT (Authorization Information)
312     * @see AbstractGroup#insertRepetition(Structure, int) 
313     */
314    public AUT insertAUT(int rep) throws HL7Exception { 
315       return (AUT)super.insertRepetition("AUT", rep);
316    }
317
318
319    /**
320     * Removes a specific repetition of AUT (Authorization Information)
321     * @see AbstractGroup#removeRepetition(String, int) 
322     */
323    public AUT removeAUT(int rep) throws HL7Exception { 
324       return (AUT)super.removeRepetition("AUT", rep);
325    }
326
327
328
329    /**
330     * Returns
331     * the first repetition of 
332     * RF1 (Referral Information) - creates it if necessary
333     */
334    public RF1 getRF1() { 
335       RF1 retVal = getTyped("RF1", RF1.class);
336       return retVal;
337    }
338
339
340    /**
341     * Returns a specific repetition of
342     * RF1 (Referral Information) - creates it if necessary
343     *
344     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
345     * @throws HL7Exception if the repetition requested is more than one 
346     *     greater than the number of existing repetitions.
347     */
348    public RF1 getRF1(int rep) { 
349       RF1 retVal = getTyped("RF1", rep, RF1.class);
350       return retVal;
351    }
352
353    /** 
354     * Returns the number of existing repetitions of RF1 
355     */ 
356    public int getRF1Reps() {  
357        return getReps("RF1");
358    } 
359
360    /** 
361     * <p>
362     * Returns a non-modifiable List containing all current existing repetitions of RF1.
363     * <p>
364     * <p>
365     * Note that unlike {@link #getRF1()}, this method will not create any reps
366     * if none are already present, so an empty list may be returned.
367     * </p>
368     */ 
369    public java.util.List<RF1> getRF1All() throws HL7Exception {
370        return getAllAsList("RF1", RF1.class);
371    } 
372
373    /**
374     * Inserts a specific repetition of RF1 (Referral Information)
375     * @see AbstractGroup#insertRepetition(Structure, int) 
376     */
377    public void insertRF1(RF1 structure, int rep) throws HL7Exception { 
378       super.insertRepetition("RF1", structure, rep);
379    }
380
381
382    /**
383     * Inserts a specific repetition of RF1 (Referral Information)
384     * @see AbstractGroup#insertRepetition(Structure, int) 
385     */
386    public RF1 insertRF1(int rep) throws HL7Exception { 
387       return (RF1)super.insertRepetition("RF1", rep);
388    }
389
390
391    /**
392     * Removes a specific repetition of RF1 (Referral Information)
393     * @see AbstractGroup#removeRepetition(String, int) 
394     */
395    public RF1 removeRF1(int rep) throws HL7Exception { 
396       return (RF1)super.removeRepetition("RF1", rep);
397    }
398
399
400
401}
402