Source code

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