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 ADR_A19 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: ERR (ERROR) <b>optional </b> </li>
052                                 * <li>4: QRD (QUERY DEFINITION) <b> </b> </li>
053                                 * <li>5: ADR_A19_QUERY_RESPONSE (a Group object) <b> repeating</b> </li>
054                                 * <li>6: DSC (CONTINUATION POINTER) <b>optional </b> </li>
055 * </ul>
056 */
057//@SuppressWarnings("unused")
058public class ADR_A19 extends AbstractMessage  {
059
060    /**
061     * Creates a new ADR_A19 message with DefaultModelClassFactory. 
062     */ 
063    public ADR_A19() { 
064       this(new DefaultModelClassFactory());
065    }
066
067    /** 
068     * Creates a new ADR_A19 message with custom ModelClassFactory.
069     */
070    public ADR_A19(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(ERR.class, false, false);
080                                  this.add(QRD.class, true, false);
081                                  this.add(ADR_A19_QUERY_RESPONSE.class, true, true);
082                                  this.add(DSC.class, false, false);
083               } catch(HL7Exception e) {
084          log.error("Unexpected error creating ADR_A19 - this is probably a bug in the source code generator.", e);
085       }
086    }
087
088
089    /** 
090     * Returns "2.2"
091     */
092    public String getVersion() {
093       return "2.2";
094    }
095
096
097
098
099    /**
100     * <p>
101     * Returns
102     * MSH (MESSAGE HEADER) - creates it if necessary
103     * </p>
104     * 
105     *
106     */
107    public MSH getMSH() { 
108       return getTyped("MSH", MSH.class);
109    }
110
111
112
113
114
115    /**
116     * <p>
117     * Returns
118     * MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary
119     * </p>
120     * 
121     *
122     */
123    public MSA getMSA() { 
124       return getTyped("MSA", MSA.class);
125    }
126
127
128
129
130
131    /**
132     * <p>
133     * Returns
134     * ERR (ERROR) - creates it if necessary
135     * </p>
136     * 
137     *
138     */
139    public ERR getERR() { 
140       return getTyped("ERR", ERR.class);
141    }
142
143
144
145
146
147    /**
148     * <p>
149     * Returns
150     * QRD (QUERY DEFINITION) - creates it if necessary
151     * </p>
152     * 
153     *
154     */
155    public QRD getQRD() { 
156       return getTyped("QRD", QRD.class);
157    }
158
159
160
161
162
163    /**
164     * <p>
165     * Returns
166     * the first repetition of 
167     * QUERY_RESPONSE (a Group object) - creates it if necessary
168     * </p>
169     * 
170     *
171     */
172    public ADR_A19_QUERY_RESPONSE getQUERY_RESPONSE() { 
173       return getTyped("QUERY_RESPONSE", ADR_A19_QUERY_RESPONSE.class);
174    }
175
176
177    /**
178     * <p>
179     * Returns a specific repetition of
180     * QUERY_RESPONSE (a Group object) - creates it if necessary
181     * </p>
182     * 
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 ADR_A19_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 
189       return getTyped("QUERY_RESPONSE", rep, ADR_A19_QUERY_RESPONSE.class);
190    }
191
192    /** 
193     * <p>
194     * Returns the number of existing repetitions of QUERY_RESPONSE 
195     * </p>
196     * 
197     */ 
198    public int getQUERY_RESPONSEReps() { 
199        return getReps("QUERY_RESPONSE");
200    } 
201
202    /** 
203     * <p>
204     * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
205     * <p>
206     * <p>
207     * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps
208     * if none are already present, so an empty list may be returned.
209     * </p>
210     * 
211     */ 
212    public java.util.List<ADR_A19_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception {
213        return getAllAsList("QUERY_RESPONSE", ADR_A19_QUERY_RESPONSE.class);
214    } 
215
216    /**
217     * <p>
218     * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
219     * </p>
220     * 
221     *
222     * @see AbstractGroup#insertRepetition(Structure, int) 
223     */
224    public void insertQUERY_RESPONSE(ADR_A19_QUERY_RESPONSE structure, int rep) throws HL7Exception { 
225       super.insertRepetition( "QUERY_RESPONSE", structure, rep);
226    }
227
228
229    /**
230     * <p>
231     * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
232     * </p>
233     * 
234     *
235     * @see AbstractGroup#insertRepetition(Structure, int) 
236     */
237    public ADR_A19_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 
238       return (ADR_A19_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep);
239    }
240
241
242    /**
243     * <p>
244     * Removes a specific repetition of QUERY_RESPONSE (a Group object)
245     * </p>
246     * 
247     *
248     * @see AbstractGroup#removeRepetition(String, int) 
249     */
250    public ADR_A19_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 
251       return (ADR_A19_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep);
252    }
253
254
255
256
257    /**
258     * <p>
259     * Returns
260     * DSC (CONTINUATION POINTER) - creates it if necessary
261     * </p>
262     * 
263     *
264     */
265    public DSC getDSC() { 
266       return getTyped("DSC", DSC.class);
267    }
268
269
270
271
272}
273