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