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