View Javadoc
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 ADT_A01_INSURANCE 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: IN1 (Insurance) <b>  </b></li>
49                           * <li>2: IN2 (Insurance Additional Information) <b>optional  </b></li>
50                           * <li>3: IN3 (Insurance Additional Information, Certification) <b>optional repeating </b></li>
51                           * <li>4: ROL (Role) <b>optional repeating </b></li>
52   * </ul>
53   */
54  //@SuppressWarnings("unused")
55  public class ADT_A01_INSURANCE extends AbstractGroup {
56  
57      /** 
58       * Creates a new ADT_A01_INSURANCE group
59       */
60      public ADT_A01_INSURANCE(Group parent, ModelClassFactory factory) {
61         super(parent, factory);
62         init(factory);
63      }
64  
65      private void init(ModelClassFactory factory) {
66         try {
67                                    this.add(IN1.class, true, false, false);
68                                    this.add(IN2.class, false, false, false);
69                                    this.add(IN3.class, false, true, false);
70                                    this.add(ROL.class, false, true, false);
71         } catch(HL7Exception e) {
72            log.error("Unexpected error creating ADT_A01_INSURANCE - this is probably a bug in the source code generator.", e);
73         }
74      }
75  
76      /** 
77       * Returns "2.5"
78       */
79      public String getVersion() {
80         return "2.5";
81      }
82  
83  
84  
85      /**
86       * Returns
87       * IN1 (Insurance) - creates it if necessary
88       */
89      public IN1 getIN1() { 
90         IN1 retVal = getTyped("IN1", IN1.class);
91         return retVal;
92      }
93  
94  
95  
96  
97      /**
98       * Returns
99       * IN2 (Insurance Additional Information) - creates it if necessary
100      */
101     public IN2 getIN2() { 
102        IN2 retVal = getTyped("IN2", IN2.class);
103        return retVal;
104     }
105 
106 
107 
108 
109     /**
110      * Returns
111      * the first repetition of 
112      * IN3 (Insurance Additional Information, Certification) - creates it if necessary
113      */
114     public IN3 getIN3() { 
115        IN3 retVal = getTyped("IN3", IN3.class);
116        return retVal;
117     }
118 
119 
120     /**
121      * Returns a specific repetition of
122      * IN3 (Insurance Additional Information, Certification) - creates it if necessary
123      *
124      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
125      * @throws HL7Exception if the repetition requested is more than one 
126      *     greater than the number of existing repetitions.
127      */
128     public IN3 getIN3(int rep) { 
129        IN3 retVal = getTyped("IN3", rep, IN3.class);
130        return retVal;
131     }
132 
133     /** 
134      * Returns the number of existing repetitions of IN3 
135      */ 
136     public int getIN3Reps() {  
137         return getReps("IN3");
138     } 
139 
140     /** 
141      * <p>
142      * Returns a non-modifiable List containing all current existing repetitions of IN3.
143      * <p>
144      * <p>
145      * Note that unlike {@link #getIN3()}, this method will not create any reps
146      * if none are already present, so an empty list may be returned.
147      * </p>
148      */ 
149     public java.util.List<IN3> getIN3All() throws HL7Exception {
150     	return getAllAsList("IN3", IN3.class);
151     } 
152 
153     /**
154      * Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)
155      * @see AbstractGroup#insertRepetition(Structure, int) 
156      */
157     public void insertIN3(IN3 structure, int rep) throws HL7Exception { 
158        super.insertRepetition("IN3", structure, rep);
159     }
160 
161 
162     /**
163      * Inserts a specific repetition of IN3 (Insurance Additional Information, Certification)
164      * @see AbstractGroup#insertRepetition(Structure, int) 
165      */
166     public IN3 insertIN3(int rep) throws HL7Exception { 
167        return (IN3)super.insertRepetition("IN3", rep);
168     }
169 
170 
171     /**
172      * Removes a specific repetition of IN3 (Insurance Additional Information, Certification)
173      * @see AbstractGroup#removeRepetition(String, int) 
174      */
175     public IN3 removeIN3(int rep) throws HL7Exception { 
176        return (IN3)super.removeRepetition("IN3", rep);
177     }
178 
179 
180 
181     /**
182      * Returns
183      * the first repetition of 
184      * ROL (Role) - creates it if necessary
185      */
186     public ROL getROL() { 
187        ROL retVal = getTyped("ROL", ROL.class);
188        return retVal;
189     }
190 
191 
192     /**
193      * Returns a specific repetition of
194      * ROL (Role) - creates it if necessary
195      *
196      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
197      * @throws HL7Exception if the repetition requested is more than one 
198      *     greater than the number of existing repetitions.
199      */
200     public ROL getROL(int rep) { 
201        ROL retVal = getTyped("ROL", rep, ROL.class);
202        return retVal;
203     }
204 
205     /** 
206      * Returns the number of existing repetitions of ROL 
207      */ 
208     public int getROLReps() {  
209         return getReps("ROL");
210     } 
211 
212     /** 
213      * <p>
214      * Returns a non-modifiable List containing all current existing repetitions of ROL.
215      * <p>
216      * <p>
217      * Note that unlike {@link #getROL()}, this method will not create any reps
218      * if none are already present, so an empty list may be returned.
219      * </p>
220      */ 
221     public java.util.List<ROL> getROLAll() throws HL7Exception {
222     	return getAllAsList("ROL", ROL.class);
223     } 
224 
225     /**
226      * Inserts a specific repetition of ROL (Role)
227      * @see AbstractGroup#insertRepetition(Structure, int) 
228      */
229     public void insertROL(ROL structure, int rep) throws HL7Exception { 
230        super.insertRepetition("ROL", structure, rep);
231     }
232 
233 
234     /**
235      * Inserts a specific repetition of ROL (Role)
236      * @see AbstractGroup#insertRepetition(Structure, int) 
237      */
238     public ROL insertROL(int rep) throws HL7Exception { 
239        return (ROL)super.insertRepetition("ROL", rep);
240     }
241 
242 
243     /**
244      * Removes a specific repetition of ROL (Role)
245      * @see AbstractGroup#removeRepetition(String, int) 
246      */
247     public ROL removeROL(int rep) throws HL7Exception { 
248        return (ROL)super.removeRepetition("ROL", rep);
249     }
250 
251 
252 
253 }
254