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