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.v23.group;
035
036import ca.uhn.hl7v2.model.v23.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 CSU_C12_STUDY_SCHEDULE 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: CSS (Clinical Study Data Schedule) <b>optional </b></li>
051                 * <li>2: CSU_C12_STUDY_OBSERVATION (a Group object) <b>optional repeating</b></li>
052                 * <li>3: CSU_C12_STUDY_PHARM (a Group object) <b> repeating</b></li>
053 * </ul>
054 */
055@SuppressWarnings("unused")
056public class CSU_C12_STUDY_SCHEDULE extends AbstractGroup {
057
058    /** 
059     * Creates a new CSU_C12_STUDY_SCHEDULE group
060     */
061    public CSU_C12_STUDY_SCHEDULE(Group parent, ModelClassFactory factory) {
062       super(parent, factory);
063       init(factory);
064    }
065
066    private void init(ModelClassFactory factory) {
067       try {
068                          this.add(CSS.class, false, false);
069                          this.add(CSU_C12_STUDY_OBSERVATION.class, false, true);
070                          this.add(CSU_C12_STUDY_PHARM.class, true, true);
071       } catch(HL7Exception e) {
072          log.error("Unexpected error creating CSU_C12_STUDY_SCHEDULE - this is probably a bug in the source code generator.", e);
073       }
074    }
075
076    /** 
077     * Returns "2.3"
078     */
079    public String getVersion() {
080       return "2.3";
081    }
082
083
084
085    /**
086     * Returns
087     * CSS (Clinical Study Data Schedule) - creates it if necessary
088     */
089    public CSS getCSS() { 
090       CSS retVal = getTyped("CSS", CSS.class);
091       return retVal;
092    }
093
094
095
096
097    /**
098     * Returns
099     * the first repetition of 
100     * STUDY_OBSERVATION (a Group object) - creates it if necessary
101     */
102    public CSU_C12_STUDY_OBSERVATION getSTUDY_OBSERVATION() { 
103       CSU_C12_STUDY_OBSERVATION retVal = getTyped("STUDY_OBSERVATION", CSU_C12_STUDY_OBSERVATION.class);
104       return retVal;
105    }
106
107
108    /**
109     * Returns a specific repetition of
110     * STUDY_OBSERVATION (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 CSU_C12_STUDY_OBSERVATION getSTUDY_OBSERVATION(int rep) { 
117       CSU_C12_STUDY_OBSERVATION retVal = getTyped("STUDY_OBSERVATION", rep, CSU_C12_STUDY_OBSERVATION.class);
118       return retVal;
119    }
120
121    /** 
122     * Returns the number of existing repetitions of STUDY_OBSERVATION 
123     */ 
124    public int getSTUDY_OBSERVATIONReps() {  
125        return getReps("STUDY_OBSERVATION");
126    } 
127
128    /** 
129     * <p>
130     * Returns a non-modifiable List containing all current existing repetitions of STUDY_OBSERVATION.
131     * <p>
132     * <p>
133     * Note that unlike {@link #getSTUDY_OBSERVATION()}, 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 List<CSU_C12_STUDY_OBSERVATION> getSTUDY_OBSERVATIONAll() throws HL7Exception {
138        return getAllAsList("STUDY_OBSERVATION", CSU_C12_STUDY_OBSERVATION.class);
139    } 
140
141    /**
142     * Inserts a specific repetition of STUDY_OBSERVATION (a Group object)
143     * @see AbstractGroup#insertRepetition(Structure, int) 
144     */
145    public void insertSTUDY_OBSERVATION(CSU_C12_STUDY_OBSERVATION structure, int rep) throws HL7Exception { 
146       super.insertRepetition("STUDY_OBSERVATION", structure, rep);
147    }
148
149
150    /**
151     * Inserts a specific repetition of STUDY_OBSERVATION (a Group object)
152     * @see AbstractGroup#insertRepetition(Structure, int) 
153     */
154    public CSU_C12_STUDY_OBSERVATION insertSTUDY_OBSERVATION(int rep) throws HL7Exception { 
155       return (CSU_C12_STUDY_OBSERVATION)super.insertRepetition("STUDY_OBSERVATION", rep);
156    }
157
158
159    /**
160     * Removes a specific repetition of STUDY_OBSERVATION (a Group object)
161     * @see AbstractGroup#removeRepetition(String, int) 
162     */
163    public CSU_C12_STUDY_OBSERVATION removeSTUDY_OBSERVATION(int rep) throws HL7Exception { 
164       return (CSU_C12_STUDY_OBSERVATION)super.removeRepetition("STUDY_OBSERVATION", rep);
165    }
166
167
168
169    /**
170     * Returns
171     * the first repetition of 
172     * STUDY_PHARM (a Group object) - creates it if necessary
173     */
174    public CSU_C12_STUDY_PHARM getSTUDY_PHARM() { 
175       CSU_C12_STUDY_PHARM retVal = getTyped("STUDY_PHARM", CSU_C12_STUDY_PHARM.class);
176       return retVal;
177    }
178
179
180    /**
181     * Returns a specific repetition of
182     * STUDY_PHARM (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 CSU_C12_STUDY_PHARM getSTUDY_PHARM(int rep) { 
189       CSU_C12_STUDY_PHARM retVal = getTyped("STUDY_PHARM", rep, CSU_C12_STUDY_PHARM.class);
190       return retVal;
191    }
192
193    /** 
194     * Returns the number of existing repetitions of STUDY_PHARM 
195     */ 
196    public int getSTUDY_PHARMReps() {  
197        return getReps("STUDY_PHARM");
198    } 
199
200    /** 
201     * <p>
202     * Returns a non-modifiable List containing all current existing repetitions of STUDY_PHARM.
203     * <p>
204     * <p>
205     * Note that unlike {@link #getSTUDY_PHARM()}, 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 List<CSU_C12_STUDY_PHARM> getSTUDY_PHARMAll() throws HL7Exception {
210        return getAllAsList("STUDY_PHARM", CSU_C12_STUDY_PHARM.class);
211    } 
212
213    /**
214     * Inserts a specific repetition of STUDY_PHARM (a Group object)
215     * @see AbstractGroup#insertRepetition(Structure, int) 
216     */
217    public void insertSTUDY_PHARM(CSU_C12_STUDY_PHARM structure, int rep) throws HL7Exception { 
218       super.insertRepetition("STUDY_PHARM", structure, rep);
219    }
220
221
222    /**
223     * Inserts a specific repetition of STUDY_PHARM (a Group object)
224     * @see AbstractGroup#insertRepetition(Structure, int) 
225     */
226    public CSU_C12_STUDY_PHARM insertSTUDY_PHARM(int rep) throws HL7Exception { 
227       return (CSU_C12_STUDY_PHARM)super.insertRepetition("STUDY_PHARM", rep);
228    }
229
230
231    /**
232     * Removes a specific repetition of STUDY_PHARM (a Group object)
233     * @see AbstractGroup#removeRepetition(String, int) 
234     */
235    public CSU_C12_STUDY_PHARM removeSTUDY_PHARM(int rep) throws HL7Exception { 
236       return (CSU_C12_STUDY_PHARM)super.removeRepetition("STUDY_PHARM", rep);
237    }
238
239
240
241}
242