View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v21.message;
35  
36  import ca.uhn.hl7v2.model.v21.group.*;
37  import ca.uhn.hl7v2.model.v21.segment.*;
38  
39  import ca.uhn.hl7v2.HL7Exception;
40  import ca.uhn.hl7v2.parser.ModelClassFactory;
41  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42  import ca.uhn.hl7v2.model.*;
43  
44  
45  /**
46   * <p>Represents a ADR_A19 message structure (see chapter ?). This structure contains the 
47   * following elements: </p>
48   * <ul>
49  		                 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li>
50  		                 * <li>2: MSA (MESSAGE ACKNOWLEDGMENT) <b> </b> </li>
51  		                 * <li>3: QRD (QUERY DEFINITION) <b> </b> </li>
52  		                 * <li>4: ADR_A19_QUERY_RESPONSE (a Group object) <b> repeating</b> </li>
53  		                 * <li>5: DSC (CONTINUATION POINTER) <b>optional </b> </li>
54   * </ul>
55   */
56  //@SuppressWarnings("unused")
57  public class ADR_A19 extends AbstractMessage  {
58  
59      /**
60       * Creates a new ADR_A19 message with DefaultModelClassFactory. 
61       */ 
62      public ADR_A19() { 
63         this(new DefaultModelClassFactory());
64      }
65  
66      /** 
67       * Creates a new ADR_A19 message with custom ModelClassFactory.
68       */
69      public ADR_A19(ModelClassFactory factory) {
70         super(factory);
71         init(factory);
72      }
73  
74      private void init(ModelClassFactory factory) {
75         try {
76                            this.add(MSH.class, true, false);
77  	                          this.add(MSA.class, true, false);
78  	                          this.add(QRD.class, true, false);
79  	                          this.add(ADR_A19_QUERY_RESPONSE.class, true, true);
80  	                          this.add(DSC.class, false, false);
81  	       } catch(HL7Exception e) {
82            log.error("Unexpected error creating ADR_A19 - this is probably a bug in the source code generator.", e);
83         }
84      }
85  
86  
87      /** 
88       * Returns "2.1"
89       */
90      public String getVersion() {
91         return "2.1";
92      }
93  
94  
95  
96  
97      /**
98       * <p>
99       * 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      * QRD (QUERY DEFINITION) - creates it if necessary
133      * </p>
134      * 
135      *
136      */
137     public QRD getQRD() { 
138        return getTyped("QRD", QRD.class);
139     }
140 
141 
142 
143 
144 
145     /**
146      * <p>
147      * Returns
148      * the first repetition of 
149      * QUERY_RESPONSE (a Group object) - creates it if necessary
150      * </p>
151      * 
152      *
153      */
154     public ADR_A19_QUERY_RESPONSE getQUERY_RESPONSE() { 
155        return getTyped("QUERY_RESPONSE", ADR_A19_QUERY_RESPONSE.class);
156     }
157 
158 
159     /**
160      * <p>
161      * Returns a specific repetition of
162      * QUERY_RESPONSE (a Group object) - creates it if necessary
163      * </p>
164      * 
165      *
166      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
167      * @throws HL7Exception if the repetition requested is more than one 
168      *     greater than the number of existing repetitions.
169      */
170     public ADR_A19_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 
171        return getTyped("QUERY_RESPONSE", rep, ADR_A19_QUERY_RESPONSE.class);
172     }
173 
174     /** 
175      * <p>
176      * Returns the number of existing repetitions of QUERY_RESPONSE 
177      * </p>
178      * 
179      */ 
180     public int getQUERY_RESPONSEReps() { 
181     	return getReps("QUERY_RESPONSE");
182     } 
183 
184     /** 
185      * <p>
186      * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE.
187      * <p>
188      * <p>
189      * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps
190      * if none are already present, so an empty list may be returned.
191      * </p>
192      * 
193      */ 
194     public java.util.List<ADR_A19_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception {
195     	return getAllAsList("QUERY_RESPONSE", ADR_A19_QUERY_RESPONSE.class);
196     } 
197 
198     /**
199      * <p>
200      * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
201      * </p>
202      * 
203      *
204      * @see AbstractGroup#insertRepetition(Structure, int) 
205      */
206     public void insertQUERY_RESPONSE(ADR_A19_QUERY_RESPONSE structure, int rep) throws HL7Exception { 
207        super.insertRepetition( "QUERY_RESPONSE", structure, rep);
208     }
209 
210 
211     /**
212      * <p>
213      * Inserts a specific repetition of QUERY_RESPONSE (a Group object)
214      * </p>
215      * 
216      *
217      * @see AbstractGroup#insertRepetition(Structure, int) 
218      */
219     public ADR_A19_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 
220        return (ADR_A19_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep);
221     }
222 
223 
224     /**
225      * <p>
226      * Removes a specific repetition of QUERY_RESPONSE (a Group object)
227      * </p>
228      * 
229      *
230      * @see AbstractGroup#removeRepetition(String, int) 
231      */
232     public ADR_A19_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 
233        return (ADR_A19_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep);
234     }
235 
236 
237 
238 
239     /**
240      * <p>
241      * Returns
242      * DSC (CONTINUATION POINTER) - creates it if necessary
243      * </p>
244      * 
245      *
246      */
247     public DSC getDSC() { 
248        return getTyped("DSC", DSC.class);
249     }
250 
251 
252 
253 
254 }
255