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