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.v231.group;
35  
36  import ca.uhn.hl7v2.model.v231.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 RQA_I08_GT1IN1IN2IN3 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: GT1 (GT1 - guarantor segment) <b>optional repeating </b></li>
49                           * <li>2: RQA_I08_IN1IN2IN3 (a Group object) <b> repeating </b></li>
50   * </ul>
51   */
52  //@SuppressWarnings("unused")
53  public class RQA_I08_GT1IN1IN2IN3 extends AbstractGroup {
54  
55      /** 
56       * Creates a new RQA_I08_GT1IN1IN2IN3 group
57       */
58      public RQA_I08_GT1IN1IN2IN3(Group parent, ModelClassFactory factory) {
59         super(parent, factory);
60         init(factory);
61      }
62  
63      private void init(ModelClassFactory factory) {
64         try {
65                                    this.add(GT1.class, false, true, false);
66                                    this.add(RQA_I08_IN1IN2IN3.class, true, true, false);
67         } catch(HL7Exception e) {
68            log.error("Unexpected error creating RQA_I08_GT1IN1IN2IN3 - this is probably a bug in the source code generator.", e);
69         }
70      }
71  
72      /** 
73       * Returns "2.3.1"
74       */
75      public String getVersion() {
76         return "2.3.1";
77      }
78  
79  
80  
81      /**
82       * Returns
83       * the first repetition of 
84       * GT1 (GT1 - guarantor segment) - creates it if necessary
85       */
86      public GT1 getGT1() { 
87         GT1 retVal = getTyped("GT1", GT1.class);
88         return retVal;
89      }
90  
91  
92      /**
93       * Returns a specific repetition of
94       * GT1 (GT1 - guarantor segment) - creates it if necessary
95       *
96       * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
97       * @throws HL7Exception if the repetition requested is more than one 
98       *     greater than the number of existing repetitions.
99       */
100     public GT1 getGT1(int rep) { 
101        GT1 retVal = getTyped("GT1", rep, GT1.class);
102        return retVal;
103     }
104 
105     /** 
106      * Returns the number of existing repetitions of GT1 
107      */ 
108     public int getGT1Reps() {  
109         return getReps("GT1");
110     } 
111 
112     /** 
113      * <p>
114      * Returns a non-modifiable List containing all current existing repetitions of GT1.
115      * <p>
116      * <p>
117      * Note that unlike {@link #getGT1()}, this method will not create any reps
118      * if none are already present, so an empty list may be returned.
119      * </p>
120      */ 
121     public java.util.List<GT1> getGT1All() throws HL7Exception {
122     	return getAllAsList("GT1", GT1.class);
123     } 
124 
125     /**
126      * Inserts a specific repetition of GT1 (GT1 - guarantor segment)
127      * @see AbstractGroup#insertRepetition(Structure, int) 
128      */
129     public void insertGT1(GT1 structure, int rep) throws HL7Exception { 
130        super.insertRepetition("GT1", structure, rep);
131     }
132 
133 
134     /**
135      * Inserts a specific repetition of GT1 (GT1 - guarantor segment)
136      * @see AbstractGroup#insertRepetition(Structure, int) 
137      */
138     public GT1 insertGT1(int rep) throws HL7Exception { 
139        return (GT1)super.insertRepetition("GT1", rep);
140     }
141 
142 
143     /**
144      * Removes a specific repetition of GT1 (GT1 - guarantor segment)
145      * @see AbstractGroup#removeRepetition(String, int) 
146      */
147     public GT1 removeGT1(int rep) throws HL7Exception { 
148        return (GT1)super.removeRepetition("GT1", rep);
149     }
150 
151 
152 
153     /**
154      * Returns
155      * the first repetition of 
156      * IN1IN2IN3 (a Group object) - creates it if necessary
157      */
158     public RQA_I08_IN1IN2IN3 getIN1IN2IN3() { 
159        RQA_I08_IN1IN2IN3 retVal = getTyped("IN1IN2IN3", RQA_I08_IN1IN2IN3.class);
160        return retVal;
161     }
162 
163 
164     /**
165      * Returns a specific repetition of
166      * IN1IN2IN3 (a Group object) - creates it if necessary
167      *
168      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
169      * @throws HL7Exception if the repetition requested is more than one 
170      *     greater than the number of existing repetitions.
171      */
172     public RQA_I08_IN1IN2IN3 getIN1IN2IN3(int rep) { 
173        RQA_I08_IN1IN2IN3 retVal = getTyped("IN1IN2IN3", rep, RQA_I08_IN1IN2IN3.class);
174        return retVal;
175     }
176 
177     /** 
178      * Returns the number of existing repetitions of IN1IN2IN3 
179      */ 
180     public int getIN1IN2IN3Reps() {  
181         return getReps("IN1IN2IN3");
182     } 
183 
184     /** 
185      * <p>
186      * Returns a non-modifiable List containing all current existing repetitions of IN1IN2IN3.
187      * <p>
188      * <p>
189      * Note that unlike {@link #getIN1IN2IN3()}, this method will not create any reps
190      * if none are already present, so an empty list may be returned.
191      * </p>
192      */ 
193     public java.util.List<RQA_I08_IN1IN2IN3> getIN1IN2IN3All() throws HL7Exception {
194     	return getAllAsList("IN1IN2IN3", RQA_I08_IN1IN2IN3.class);
195     } 
196 
197     /**
198      * Inserts a specific repetition of IN1IN2IN3 (a Group object)
199      * @see AbstractGroup#insertRepetition(Structure, int) 
200      */
201     public void insertIN1IN2IN3(RQA_I08_IN1IN2IN3 structure, int rep) throws HL7Exception { 
202        super.insertRepetition("IN1IN2IN3", structure, rep);
203     }
204 
205 
206     /**
207      * Inserts a specific repetition of IN1IN2IN3 (a Group object)
208      * @see AbstractGroup#insertRepetition(Structure, int) 
209      */
210     public RQA_I08_IN1IN2IN3 insertIN1IN2IN3(int rep) throws HL7Exception { 
211        return (RQA_I08_IN1IN2IN3)super.insertRepetition("IN1IN2IN3", rep);
212     }
213 
214 
215     /**
216      * Removes a specific repetition of IN1IN2IN3 (a Group object)
217      * @see AbstractGroup#removeRepetition(String, int) 
218      */
219     public RQA_I08_IN1IN2IN3 removeIN1IN2IN3(int rep) throws HL7Exception { 
220        return (RQA_I08_IN1IN2IN3)super.removeRepetition("IN1IN2IN3", rep);
221     }
222 
223 
224 
225 }
226