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.v26.group;
035
036import ca.uhn.hl7v2.model.v26.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 DFT_P03_COMMON_ORDER 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: ORC (Common Order) <b>optional </b></li>
051                 * <li>2: DFT_P03_TIMING_QUANTITY (a Group object) <b>optional repeating</b></li>
052                 * <li>3: DFT_P03_ORDER (a Group object) <b>optional </b></li>
053                 * <li>4: DFT_P03_OBSERVATION (a Group object) <b>optional repeating</b></li>
054 * </ul>
055 */
056@SuppressWarnings("unused")
057public class DFT_P03_COMMON_ORDER extends AbstractGroup {
058
059    /** 
060     * Creates a new DFT_P03_COMMON_ORDER group
061     */
062    public DFT_P03_COMMON_ORDER(Group parent, ModelClassFactory factory) {
063       super(parent, factory);
064       init(factory);
065    }
066
067    private void init(ModelClassFactory factory) {
068       try {
069                          this.add(ORC.class, false, false);
070                          this.add(DFT_P03_TIMING_QUANTITY.class, false, true);
071                          this.add(DFT_P03_ORDER.class, false, false);
072                          this.add(DFT_P03_OBSERVATION.class, false, true);
073       } catch(HL7Exception e) {
074          log.error("Unexpected error creating DFT_P03_COMMON_ORDER - this is probably a bug in the source code generator.", e);
075       }
076    }
077
078    /** 
079     * Returns "2.6"
080     */
081    public String getVersion() {
082       return "2.6";
083    }
084
085
086
087    /**
088     * Returns
089     * ORC (Common Order) - creates it if necessary
090     */
091    public ORC getORC() { 
092       ORC retVal = getTyped("ORC", ORC.class);
093       return retVal;
094    }
095
096
097
098
099    /**
100     * Returns
101     * the first repetition of 
102     * TIMING_QUANTITY (a Group object) - creates it if necessary
103     */
104    public DFT_P03_TIMING_QUANTITY getTIMING_QUANTITY() { 
105       DFT_P03_TIMING_QUANTITY retVal = getTyped("TIMING_QUANTITY", DFT_P03_TIMING_QUANTITY.class);
106       return retVal;
107    }
108
109
110    /**
111     * Returns a specific repetition of
112     * TIMING_QUANTITY (a Group object) - creates it if necessary
113     *
114     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
115     * @throws HL7Exception if the repetition requested is more than one 
116     *     greater than the number of existing repetitions.
117     */
118    public DFT_P03_TIMING_QUANTITY getTIMING_QUANTITY(int rep) { 
119       DFT_P03_TIMING_QUANTITY retVal = getTyped("TIMING_QUANTITY", rep, DFT_P03_TIMING_QUANTITY.class);
120       return retVal;
121    }
122
123    /** 
124     * Returns the number of existing repetitions of TIMING_QUANTITY 
125     */ 
126    public int getTIMING_QUANTITYReps() {  
127        return getReps("TIMING_QUANTITY");
128    } 
129
130    /** 
131     * <p>
132     * Returns a non-modifiable List containing all current existing repetitions of TIMING_QUANTITY.
133     * <p>
134     * <p>
135     * Note that unlike {@link #getTIMING_QUANTITY()}, this method will not create any reps
136     * if none are already present, so an empty list may be returned.
137     * </p>
138     */ 
139    public List<DFT_P03_TIMING_QUANTITY> getTIMING_QUANTITYAll() throws HL7Exception {
140        return getAllAsList("TIMING_QUANTITY", DFT_P03_TIMING_QUANTITY.class);
141    } 
142
143    /**
144     * Inserts a specific repetition of TIMING_QUANTITY (a Group object)
145     * @see AbstractGroup#insertRepetition(Structure, int) 
146     */
147    public void insertTIMING_QUANTITY(DFT_P03_TIMING_QUANTITY structure, int rep) throws HL7Exception { 
148       super.insertRepetition("TIMING_QUANTITY", structure, rep);
149    }
150
151
152    /**
153     * Inserts a specific repetition of TIMING_QUANTITY (a Group object)
154     * @see AbstractGroup#insertRepetition(Structure, int) 
155     */
156    public DFT_P03_TIMING_QUANTITY insertTIMING_QUANTITY(int rep) throws HL7Exception { 
157       return (DFT_P03_TIMING_QUANTITY)super.insertRepetition("TIMING_QUANTITY", rep);
158    }
159
160
161    /**
162     * Removes a specific repetition of TIMING_QUANTITY (a Group object)
163     * @see AbstractGroup#removeRepetition(String, int) 
164     */
165    public DFT_P03_TIMING_QUANTITY removeTIMING_QUANTITY(int rep) throws HL7Exception { 
166       return (DFT_P03_TIMING_QUANTITY)super.removeRepetition("TIMING_QUANTITY", rep);
167    }
168
169
170
171    /**
172     * Returns
173     * ORDER (a Group object) - creates it if necessary
174     */
175    public DFT_P03_ORDER getORDER() { 
176       DFT_P03_ORDER retVal = getTyped("ORDER", DFT_P03_ORDER.class);
177       return retVal;
178    }
179
180
181
182
183    /**
184     * Returns
185     * the first repetition of 
186     * OBSERVATION (a Group object) - creates it if necessary
187     */
188    public DFT_P03_OBSERVATION getOBSERVATION() { 
189       DFT_P03_OBSERVATION retVal = getTyped("OBSERVATION", DFT_P03_OBSERVATION.class);
190       return retVal;
191    }
192
193
194    /**
195     * Returns a specific repetition of
196     * OBSERVATION (a Group object) - creates it if necessary
197     *
198     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
199     * @throws HL7Exception if the repetition requested is more than one 
200     *     greater than the number of existing repetitions.
201     */
202    public DFT_P03_OBSERVATION getOBSERVATION(int rep) { 
203       DFT_P03_OBSERVATION retVal = getTyped("OBSERVATION", rep, DFT_P03_OBSERVATION.class);
204       return retVal;
205    }
206
207    /** 
208     * Returns the number of existing repetitions of OBSERVATION 
209     */ 
210    public int getOBSERVATIONReps() {  
211        return getReps("OBSERVATION");
212    } 
213
214    /** 
215     * <p>
216     * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
217     * <p>
218     * <p>
219     * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
220     * if none are already present, so an empty list may be returned.
221     * </p>
222     */ 
223    public List<DFT_P03_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
224        return getAllAsList("OBSERVATION", DFT_P03_OBSERVATION.class);
225    } 
226
227    /**
228     * Inserts a specific repetition of OBSERVATION (a Group object)
229     * @see AbstractGroup#insertRepetition(Structure, int) 
230     */
231    public void insertOBSERVATION(DFT_P03_OBSERVATION structure, int rep) throws HL7Exception { 
232       super.insertRepetition("OBSERVATION", structure, rep);
233    }
234
235
236    /**
237     * Inserts a specific repetition of OBSERVATION (a Group object)
238     * @see AbstractGroup#insertRepetition(Structure, int) 
239     */
240    public DFT_P03_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 
241       return (DFT_P03_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
242    }
243
244
245    /**
246     * Removes a specific repetition of OBSERVATION (a Group object)
247     * @see AbstractGroup#removeRepetition(String, int) 
248     */
249    public DFT_P03_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 
250       return (DFT_P03_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
251    }
252
253
254
255}
256