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.v23.message;
035
036import ca.uhn.hl7v2.model.v23.group.*;
037import ca.uhn.hl7v2.model.v23.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 segment) <b> </b></li>
051                 * <li>2: MSA (Message acknowledgement segment) <b> </b></li>
052                 * <li>3: QRD (Query definition segment) <b> </b></li>
053                 * <li>4: QRF (Query filter segment) <b>optional </b></li>
054                 * <li>5: ORF_R04_QUERY_RESPONSE (a Group object) <b> repeating</b></li>
055                 * <li>6: DSC (Continuation pointer segment) <b>optional </b></li>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class ORF_R04 extends AbstractMessage  {
060
061    /**
062     * Creates a new ORF_R04 message with DefaultModelClassFactory. 
063     */ 
064    public ORF_R04() { 
065       this(new DefaultModelClassFactory());
066    }
067
068    /** 
069     * Creates a new ORF_R04 message with custom ModelClassFactory.
070     */
071    public ORF_R04(ModelClassFactory factory) {
072       super(factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                          this.add(MSH.class, true, false);
079                          this.add(MSA.class, true, false);
080                          this.add(QRD.class, true, false);
081                          this.add(QRF.class, false, false);
082                          this.add(ORF_R04_QUERY_RESPONSE.class, true, true);
083                          this.add(DSC.class, false, false);
084       } catch(HL7Exception e) {
085          log.error("Unexpected error creating ORF_R04 - this is probably a bug in the source code generator.", e);
086       }
087    }
088
089    /** 
090     * Returns "2.3"
091     */
092    public String getVersion() {
093       return "2.3";
094    }
095
096
097
098    /**
099     * Returns
100     * MSH (Message header segment) - creates it if necessary
101     */
102    public MSH getMSH() { 
103       return getTyped("MSH", MSH.class);
104    }
105
106
107
108
109    /**
110     * Returns
111     * MSA (Message acknowledgement segment) - creates it if necessary
112     */
113    public MSA getMSA() { 
114       return getTyped("MSA", MSA.class);
115    }
116
117
118
119
120    /**
121     * Returns
122     * QRD (Query definition segment) - creates it if necessary
123     */
124    public QRD getQRD() { 
125       return getTyped("QRD", QRD.class);
126    }
127
128
129
130
131    /**
132     * Returns
133     * QRF (Query filter segment) - creates it if necessary
134     */
135    public QRF getQRF() { 
136       return getTyped("QRF", QRF.class);
137    }
138
139
140
141
142    /**
143     * Returns
144     * the first repetition of 
145     * QUERY_RESPONSE (a Group object) - creates it if necessary
146     */
147    public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE() { 
148       return getTyped("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class);
149    }
150
151
152    /**
153     * Returns a specific repetition of
154     * QUERY_RESPONSE (a Group object) - creates it if necessary
155     *
156     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
157     * @throws HL7Exception if the repetition requested is more than one 
158     *     greater than the number of existing repetitions.
159     */
160    public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 
161       return getTyped("QUERY_RESPONSE", rep, ORF_R04_QUERY_RESPONSE.class);
162    }
163
164    /** 
165     * Returns the number of existing repetitions of QUERY_RESPONSE 
166     */ 
167    public int getQUERY_RESPONSEReps() { 
168        return getReps("QUERY_RESPONSE");
169    } 
170
171    /** 
172     * <p>
173     * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
174     * <p>
175     * <p>
176     * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps
177     * if none are already present, so an empty list may be returned.
178     * </p>
179     */ 
180    public List<ORF_R04_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception {
181        return getAllAsList("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class);
182    } 
183
184    /**
185     * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
186     * @see AbstractGroup#insertRepetition(Structure, int) 
187     */
188    public void insertQUERY_RESPONSE(ORF_R04_QUERY_RESPONSE structure, int rep) throws HL7Exception { 
189       super.insertRepetition( "QUERY_RESPONSE", structure, rep);
190    }
191
192
193    /**
194     * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
195     * @see AbstractGroup#insertRepetition(Structure, int) 
196     */
197    public ORF_R04_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 
198       return (ORF_R04_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep);
199    }
200
201
202    /**
203     * Removes a specific repetition of QUERY_RESPONSE (a Group object)
204     * @see AbstractGroup#removeRepetition(String, int) 
205     */
206    public ORF_R04_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 
207       return (ORF_R04_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep);
208    }
209
210
211
212    /**
213     * Returns
214     * DSC (Continuation pointer segment) - creates it if necessary
215     */
216    public DSC getDSC() { 
217       return getTyped("DSC", DSC.class);
218    }
219
220
221
222
223}
224