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.v22.message;
035
036import ca.uhn.hl7v2.model.v22.group.*;
037import ca.uhn.hl7v2.model.v22.segment.*;
038
039import ca.uhn.hl7v2.HL7Exception;
040import ca.uhn.hl7v2.parser.ModelClassFactory;
041import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044
045/**
046 * <p>Represents a ORF_R04 message structure (see chapter ?). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li>
050                                 * <li>2: MSA (MESSAGE ACKNOWLEDGMENT) <b> </b> </li>
051                                 * <li>3: ORF_R04_QUERY_RESPONSE (a Group object) <b> repeating</b> </li>
052                                 * <li>4: ORF_R04_ORDER (a Group object) <b> repeating</b> </li>
053                                 * <li>5: DSC (CONTINUATION POINTER) <b>optional </b> </li>
054 * </ul>
055 */
056//@SuppressWarnings("unused")
057public class ORF_R04 extends AbstractMessage  {
058
059    /**
060     * Creates a new ORF_R04 message with DefaultModelClassFactory. 
061     */ 
062    public ORF_R04() { 
063       this(new DefaultModelClassFactory());
064    }
065
066    /** 
067     * Creates a new ORF_R04 message with custom ModelClassFactory.
068     */
069    public ORF_R04(ModelClassFactory factory) {
070       super(factory);
071       init(factory);
072    }
073
074    private void init(ModelClassFactory factory) {
075       try {
076                          this.add(MSH.class, true, false);
077                                  this.add(MSA.class, true, false);
078                                  this.add(ORF_R04_QUERY_RESPONSE.class, true, true);
079                                  this.add(ORF_R04_ORDER.class, true, true);
080                                  this.add(DSC.class, false, false);
081               } catch(HL7Exception e) {
082          log.error("Unexpected error creating ORF_R04 - this is probably a bug in the source code generator.", e);
083       }
084    }
085
086
087    /** 
088     * Returns "2.2"
089     */
090    public String getVersion() {
091       return "2.2";
092    }
093
094
095
096
097    /**
098     * <p>
099     * Returns
100     * MSH (MESSAGE HEADER) - creates it if necessary
101     * </p>
102     * 
103     *
104     */
105    public MSH getMSH() { 
106       return getTyped("MSH", MSH.class);
107    }
108
109
110
111
112
113    /**
114     * <p>
115     * Returns
116     * MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary
117     * </p>
118     * 
119     *
120     */
121    public MSA getMSA() { 
122       return getTyped("MSA", MSA.class);
123    }
124
125
126
127
128
129    /**
130     * <p>
131     * Returns
132     * the first repetition of 
133     * QUERY_RESPONSE (a Group object) - creates it if necessary
134     * </p>
135     * 
136     *
137     */
138    public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE() { 
139       return getTyped("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class);
140    }
141
142
143    /**
144     * <p>
145     * Returns a specific repetition of
146     * QUERY_RESPONSE (a Group object) - creates it if necessary
147     * </p>
148     * 
149     *
150     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
151     * @throws HL7Exception if the repetition requested is more than one 
152     *     greater than the number of existing repetitions.
153     */
154    public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 
155       return getTyped("QUERY_RESPONSE", rep, ORF_R04_QUERY_RESPONSE.class);
156    }
157
158    /** 
159     * <p>
160     * Returns the number of existing repetitions of QUERY_RESPONSE 
161     * </p>
162     * 
163     */ 
164    public int getQUERY_RESPONSEReps() { 
165        return getReps("QUERY_RESPONSE");
166    } 
167
168    /** 
169     * <p>
170     * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
171     * <p>
172     * <p>
173     * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps
174     * if none are already present, so an empty list may be returned.
175     * </p>
176     * 
177     */ 
178    public java.util.List<ORF_R04_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception {
179        return getAllAsList("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class);
180    } 
181
182    /**
183     * <p>
184     * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
185     * </p>
186     * 
187     *
188     * @see AbstractGroup#insertRepetition(Structure, int) 
189     */
190    public void insertQUERY_RESPONSE(ORF_R04_QUERY_RESPONSE structure, int rep) throws HL7Exception { 
191       super.insertRepetition( "QUERY_RESPONSE", structure, rep);
192    }
193
194
195    /**
196     * <p>
197     * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
198     * </p>
199     * 
200     *
201     * @see AbstractGroup#insertRepetition(Structure, int) 
202     */
203    public ORF_R04_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 
204       return (ORF_R04_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep);
205    }
206
207
208    /**
209     * <p>
210     * Removes a specific repetition of QUERY_RESPONSE (a Group object)
211     * </p>
212     * 
213     *
214     * @see AbstractGroup#removeRepetition(String, int) 
215     */
216    public ORF_R04_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 
217       return (ORF_R04_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep);
218    }
219
220
221
222
223    /**
224     * <p>
225     * Returns
226     * the first repetition of 
227     * ORDER (a Group object) - creates it if necessary
228     * </p>
229     * 
230     *
231     */
232    public ORF_R04_ORDER getORDER() { 
233       return getTyped("ORDER", ORF_R04_ORDER.class);
234    }
235
236
237    /**
238     * <p>
239     * Returns a specific repetition of
240     * ORDER (a Group object) - creates it if necessary
241     * </p>
242     * 
243     *
244     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
245     * @throws HL7Exception if the repetition requested is more than one 
246     *     greater than the number of existing repetitions.
247     */
248    public ORF_R04_ORDER getORDER(int rep) { 
249       return getTyped("ORDER", rep, ORF_R04_ORDER.class);
250    }
251
252    /** 
253     * <p>
254     * Returns the number of existing repetitions of ORDER 
255     * </p>
256     * 
257     */ 
258    public int getORDERReps() { 
259        return getReps("ORDER");
260    } 
261
262    /** 
263     * <p>
264     * Returns a non-modifiable List containing all current existing repetitions of ORDER.
265     * <p>
266     * <p>
267     * Note that unlike {@link #getORDER()}, this method will not create any reps
268     * if none are already present, so an empty list may be returned.
269     * </p>
270     * 
271     */ 
272    public java.util.List<ORF_R04_ORDER> getORDERAll() throws HL7Exception {
273        return getAllAsList("ORDER", ORF_R04_ORDER.class);
274    } 
275
276    /**
277     * <p>
278     * Inserts a specific repetition of ORDER (a Group object)
279     * </p>
280     * 
281     *
282     * @see AbstractGroup#insertRepetition(Structure, int) 
283     */
284    public void insertORDER(ORF_R04_ORDER structure, int rep) throws HL7Exception { 
285       super.insertRepetition( "ORDER", structure, rep);
286    }
287
288
289    /**
290     * <p>
291     * Inserts a specific repetition of ORDER (a Group object)
292     * </p>
293     * 
294     *
295     * @see AbstractGroup#insertRepetition(Structure, int) 
296     */
297    public ORF_R04_ORDER insertORDER(int rep) throws HL7Exception { 
298       return (ORF_R04_ORDER)super.insertRepetition("ORDER", rep);
299    }
300
301
302    /**
303     * <p>
304     * Removes a specific repetition of ORDER (a Group object)
305     * </p>
306     * 
307     *
308     * @see AbstractGroup#removeRepetition(String, int) 
309     */
310    public ORF_R04_ORDER removeORDER(int rep) throws HL7Exception { 
311       return (ORF_R04_ORDER)super.removeRepetition("ORDER", rep);
312    }
313
314
315
316
317    /**
318     * <p>
319     * Returns
320     * DSC (CONTINUATION POINTER) - creates it if necessary
321     * </p>
322     * 
323     *
324     */
325    public DSC getDSC() { 
326       return getTyped("DSC", DSC.class);
327    }
328
329
330
331
332}
333