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.group;
035
036import ca.uhn.hl7v2.model.v27.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a CQU_I19_CLINICAL_HISTORY 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: ORC (Common Order) <b>  </b></li>
049                         * <li>2: CQU_I19_CLINICAL_HISTORY_DETAIL (a Group object) <b>optional repeating </b></li>
050                         * <li>3: CQU_I19_ROLE_CLINICAL_HISTORY (a Group object) <b>optional repeating </b></li>
051                         * <li>4: CTI (Clinical Trial Identification) <b>optional repeating </b></li>
052 * </ul>
053 */
054//@SuppressWarnings("unused")
055public class CQU_I19_CLINICAL_HISTORY extends AbstractGroup {
056
057    /** 
058     * Creates a new CQU_I19_CLINICAL_HISTORY group
059     */
060    public CQU_I19_CLINICAL_HISTORY(Group parent, ModelClassFactory factory) {
061       super(parent, factory);
062       init(factory);
063    }
064
065    private void init(ModelClassFactory factory) {
066       try {
067                                  this.add(ORC.class, true, false, false);
068                                  this.add(CQU_I19_CLINICAL_HISTORY_DETAIL.class, false, true, false);
069                                  this.add(CQU_I19_ROLE_CLINICAL_HISTORY.class, false, true, false);
070                                  this.add(CTI.class, false, true, false);
071       } catch(HL7Exception e) {
072          log.error("Unexpected error creating CQU_I19_CLINICAL_HISTORY - this is probably a bug in the source code generator.", e);
073       }
074    }
075
076    /** 
077     * Returns "2.7"
078     */
079    public String getVersion() {
080       return "2.7";
081    }
082
083
084
085    /**
086     * Returns
087     * ORC (Common Order) - creates it if necessary
088     */
089    public ORC getORC() { 
090       ORC retVal = getTyped("ORC", ORC.class);
091       return retVal;
092    }
093
094
095
096
097    /**
098     * Returns
099     * the first repetition of 
100     * CLINICAL_HISTORY_DETAIL (a Group object) - creates it if necessary
101     */
102    public CQU_I19_CLINICAL_HISTORY_DETAIL getCLINICAL_HISTORY_DETAIL() { 
103       CQU_I19_CLINICAL_HISTORY_DETAIL retVal = getTyped("CLINICAL_HISTORY_DETAIL", CQU_I19_CLINICAL_HISTORY_DETAIL.class);
104       return retVal;
105    }
106
107
108    /**
109     * Returns a specific repetition of
110     * CLINICAL_HISTORY_DETAIL (a Group object) - creates it if necessary
111     *
112     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
113     * @throws HL7Exception if the repetition requested is more than one 
114     *     greater than the number of existing repetitions.
115     */
116    public CQU_I19_CLINICAL_HISTORY_DETAIL getCLINICAL_HISTORY_DETAIL(int rep) { 
117       CQU_I19_CLINICAL_HISTORY_DETAIL retVal = getTyped("CLINICAL_HISTORY_DETAIL", rep, CQU_I19_CLINICAL_HISTORY_DETAIL.class);
118       return retVal;
119    }
120
121    /** 
122     * Returns the number of existing repetitions of CLINICAL_HISTORY_DETAIL 
123     */ 
124    public int getCLINICAL_HISTORY_DETAILReps() {  
125        return getReps("CLINICAL_HISTORY_DETAIL");
126    } 
127
128    /** 
129     * <p>
130     * Returns a non-modifiable List containing all current existing repetitions of CLINICAL_HISTORY_DETAIL.
131     * <p>
132     * <p>
133     * Note that unlike {@link #getCLINICAL_HISTORY_DETAIL()}, this method will not create any reps
134     * if none are already present, so an empty list may be returned.
135     * </p>
136     */ 
137    public java.util.List<CQU_I19_CLINICAL_HISTORY_DETAIL> getCLINICAL_HISTORY_DETAILAll() throws HL7Exception {
138        return getAllAsList("CLINICAL_HISTORY_DETAIL", CQU_I19_CLINICAL_HISTORY_DETAIL.class);
139    } 
140
141    /**
142     * Inserts a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)
143     * @see AbstractGroup#insertRepetition(Structure, int) 
144     */
145    public void insertCLINICAL_HISTORY_DETAIL(CQU_I19_CLINICAL_HISTORY_DETAIL structure, int rep) throws HL7Exception { 
146       super.insertRepetition("CLINICAL_HISTORY_DETAIL", structure, rep);
147    }
148
149
150    /**
151     * Inserts a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)
152     * @see AbstractGroup#insertRepetition(Structure, int) 
153     */
154    public CQU_I19_CLINICAL_HISTORY_DETAIL insertCLINICAL_HISTORY_DETAIL(int rep) throws HL7Exception { 
155       return (CQU_I19_CLINICAL_HISTORY_DETAIL)super.insertRepetition("CLINICAL_HISTORY_DETAIL", rep);
156    }
157
158
159    /**
160     * Removes a specific repetition of CLINICAL_HISTORY_DETAIL (a Group object)
161     * @see AbstractGroup#removeRepetition(String, int) 
162     */
163    public CQU_I19_CLINICAL_HISTORY_DETAIL removeCLINICAL_HISTORY_DETAIL(int rep) throws HL7Exception { 
164       return (CQU_I19_CLINICAL_HISTORY_DETAIL)super.removeRepetition("CLINICAL_HISTORY_DETAIL", rep);
165    }
166
167
168
169    /**
170     * Returns
171     * the first repetition of 
172     * ROLE_CLINICAL_HISTORY (a Group object) - creates it if necessary
173     */
174    public CQU_I19_ROLE_CLINICAL_HISTORY getROLE_CLINICAL_HISTORY() { 
175       CQU_I19_ROLE_CLINICAL_HISTORY retVal = getTyped("ROLE_CLINICAL_HISTORY", CQU_I19_ROLE_CLINICAL_HISTORY.class);
176       return retVal;
177    }
178
179
180    /**
181     * Returns a specific repetition of
182     * ROLE_CLINICAL_HISTORY (a Group object) - creates it if necessary
183     *
184     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
185     * @throws HL7Exception if the repetition requested is more than one 
186     *     greater than the number of existing repetitions.
187     */
188    public CQU_I19_ROLE_CLINICAL_HISTORY getROLE_CLINICAL_HISTORY(int rep) { 
189       CQU_I19_ROLE_CLINICAL_HISTORY retVal = getTyped("ROLE_CLINICAL_HISTORY", rep, CQU_I19_ROLE_CLINICAL_HISTORY.class);
190       return retVal;
191    }
192
193    /** 
194     * Returns the number of existing repetitions of ROLE_CLINICAL_HISTORY 
195     */ 
196    public int getROLE_CLINICAL_HISTORYReps() {  
197        return getReps("ROLE_CLINICAL_HISTORY");
198    } 
199
200    /** 
201     * <p>
202     * Returns a non-modifiable List containing all current existing repetitions of ROLE_CLINICAL_HISTORY.
203     * <p>
204     * <p>
205     * Note that unlike {@link #getROLE_CLINICAL_HISTORY()}, this method will not create any reps
206     * if none are already present, so an empty list may be returned.
207     * </p>
208     */ 
209    public java.util.List<CQU_I19_ROLE_CLINICAL_HISTORY> getROLE_CLINICAL_HISTORYAll() throws HL7Exception {
210        return getAllAsList("ROLE_CLINICAL_HISTORY", CQU_I19_ROLE_CLINICAL_HISTORY.class);
211    } 
212
213    /**
214     * Inserts a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)
215     * @see AbstractGroup#insertRepetition(Structure, int) 
216     */
217    public void insertROLE_CLINICAL_HISTORY(CQU_I19_ROLE_CLINICAL_HISTORY structure, int rep) throws HL7Exception { 
218       super.insertRepetition("ROLE_CLINICAL_HISTORY", structure, rep);
219    }
220
221
222    /**
223     * Inserts a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)
224     * @see AbstractGroup#insertRepetition(Structure, int) 
225     */
226    public CQU_I19_ROLE_CLINICAL_HISTORY insertROLE_CLINICAL_HISTORY(int rep) throws HL7Exception { 
227       return (CQU_I19_ROLE_CLINICAL_HISTORY)super.insertRepetition("ROLE_CLINICAL_HISTORY", rep);
228    }
229
230
231    /**
232     * Removes a specific repetition of ROLE_CLINICAL_HISTORY (a Group object)
233     * @see AbstractGroup#removeRepetition(String, int) 
234     */
235    public CQU_I19_ROLE_CLINICAL_HISTORY removeROLE_CLINICAL_HISTORY(int rep) throws HL7Exception { 
236       return (CQU_I19_ROLE_CLINICAL_HISTORY)super.removeRepetition("ROLE_CLINICAL_HISTORY", rep);
237    }
238
239
240
241    /**
242     * Returns
243     * the first repetition of 
244     * CTI (Clinical Trial Identification) - creates it if necessary
245     */
246    public CTI getCTI() { 
247       CTI retVal = getTyped("CTI", CTI.class);
248       return retVal;
249    }
250
251
252    /**
253     * Returns a specific repetition of
254     * CTI (Clinical Trial Identification) - creates it if necessary
255     *
256     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
257     * @throws HL7Exception if the repetition requested is more than one 
258     *     greater than the number of existing repetitions.
259     */
260    public CTI getCTI(int rep) { 
261       CTI retVal = getTyped("CTI", rep, CTI.class);
262       return retVal;
263    }
264
265    /** 
266     * Returns the number of existing repetitions of CTI 
267     */ 
268    public int getCTIReps() {  
269        return getReps("CTI");
270    } 
271
272    /** 
273     * <p>
274     * Returns a non-modifiable List containing all current existing repetitions of CTI.
275     * <p>
276     * <p>
277     * Note that unlike {@link #getCTI()}, this method will not create any reps
278     * if none are already present, so an empty list may be returned.
279     * </p>
280     */ 
281    public java.util.List<CTI> getCTIAll() throws HL7Exception {
282        return getAllAsList("CTI", CTI.class);
283    } 
284
285    /**
286     * Inserts a specific repetition of CTI (Clinical Trial Identification)
287     * @see AbstractGroup#insertRepetition(Structure, int) 
288     */
289    public void insertCTI(CTI structure, int rep) throws HL7Exception { 
290       super.insertRepetition("CTI", structure, rep);
291    }
292
293
294    /**
295     * Inserts a specific repetition of CTI (Clinical Trial Identification)
296     * @see AbstractGroup#insertRepetition(Structure, int) 
297     */
298    public CTI insertCTI(int rep) throws HL7Exception { 
299       return (CTI)super.insertRepetition("CTI", rep);
300    }
301
302
303    /**
304     * Removes a specific repetition of CTI (Clinical Trial Identification)
305     * @see AbstractGroup#removeRepetition(String, int) 
306     */
307    public CTI removeCTI(int rep) throws HL7Exception { 
308       return (CTI)super.removeRepetition("CTI", rep);
309    }
310
311
312
313}
314