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.v24.message;
35
36 import ca.uhn.hl7v2.model.v24.group.*;
37 import ca.uhn.hl7v2.model.v24.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 OSR_Q06 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: ERR (Error) <b>optional </b> </li>
52 * <li>4: NTE (Notes and Comments) <b>optional repeating</b> </li>
53 * <li>5: QRD (Original-Style Query Definition) <b> </b> </li>
54 * <li>6: QRF (Original Style Query Filter) <b>optional </b> </li>
55 * <li>7: OSR_Q06_RESPONSE (a Group object) <b>optional </b> </li>
56 * <li>8: DSC (Continuation Pointer) <b>optional </b> </li>
57 * </ul>
58 */
59 //@SuppressWarnings("unused")
60 public class OSR_Q06 extends AbstractMessage {
61
62 /**
63 * Creates a new OSR_Q06 message with DefaultModelClassFactory.
64 */
65 public OSR_Q06() {
66 this(new DefaultModelClassFactory());
67 }
68
69 /**
70 * Creates a new OSR_Q06 message with custom ModelClassFactory.
71 */
72 public OSR_Q06(ModelClassFactory factory) {
73 super(factory);
74 init(factory);
75 }
76
77 private void init(ModelClassFactory factory) {
78 try {
79 this.add(MSH.class, true, false);
80 this.add(MSA.class, true, false);
81 this.add(ERR.class, false, false);
82 this.add(NTE.class, false, true);
83 this.add(QRD.class, true, false);
84 this.add(QRF.class, false, false);
85 this.add(OSR_Q06_RESPONSE.class, false, false);
86 this.add(DSC.class, false, false);
87 } catch(HL7Exception e) {
88 log.error("Unexpected error creating OSR_Q06 - this is probably a bug in the source code generator.", e);
89 }
90 }
91
92
93 /**
94 * Returns "2.4"
95 */
96 public String getVersion() {
97 return "2.4";
98 }
99
100
101
102
103 /**
104 * <p>
105 * Returns
106 * MSH (Message Header) - creates it if necessary
107 * </p>
108 *
109 *
110 */
111 public MSH getMSH() {
112 return getTyped("MSH", MSH.class);
113 }
114
115
116
117
118
119 /**
120 * <p>
121 * Returns
122 * MSA (Message Acknowledgment) - creates it if necessary
123 * </p>
124 *
125 *
126 */
127 public MSA getMSA() {
128 return getTyped("MSA", MSA.class);
129 }
130
131
132
133
134
135 /**
136 * <p>
137 * Returns
138 * ERR (Error) - creates it if necessary
139 * </p>
140 *
141 *
142 */
143 public ERR getERR() {
144 return getTyped("ERR", ERR.class);
145 }
146
147
148
149
150
151 /**
152 * <p>
153 * Returns
154 * the first repetition of
155 * NTE (Notes and Comments) - creates it if necessary
156 * </p>
157 *
158 *
159 */
160 public NTE getNTE() {
161 return getTyped("NTE", NTE.class);
162 }
163
164
165 /**
166 * <p>
167 * Returns a specific repetition of
168 * NTE (Notes and Comments) - creates it if necessary
169 * </p>
170 *
171 *
172 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
173 * @throws HL7Exception if the repetition requested is more than one
174 * greater than the number of existing repetitions.
175 */
176 public NTE getNTE(int rep) {
177 return getTyped("NTE", rep, NTE.class);
178 }
179
180 /**
181 * <p>
182 * Returns the number of existing repetitions of NTE
183 * </p>
184 *
185 */
186 public int getNTEReps() {
187 return getReps("NTE");
188 }
189
190 /**
191 * <p>
192 * Returns a non-modifiable List containing all current existing repetitions of NTE.
193 * <p>
194 * <p>
195 * Note that unlike {@link #getNTE()}, this method will not create any reps
196 * if none are already present, so an empty list may be returned.
197 * </p>
198 *
199 */
200 public java.util.List<NTE> getNTEAll() throws HL7Exception {
201 return getAllAsList("NTE", NTE.class);
202 }
203
204 /**
205 * <p>
206 * Inserts a specific repetition of NTE (Notes and Comments)
207 * </p>
208 *
209 *
210 * @see AbstractGroup#insertRepetition(Structure, int)
211 */
212 public void insertNTE(NTE structure, int rep) throws HL7Exception {
213 super.insertRepetition( "NTE", structure, rep);
214 }
215
216
217 /**
218 * <p>
219 * Inserts a specific repetition of NTE (Notes and Comments)
220 * </p>
221 *
222 *
223 * @see AbstractGroup#insertRepetition(Structure, int)
224 */
225 public NTE insertNTE(int rep) throws HL7Exception {
226 return (NTE)super.insertRepetition("NTE", rep);
227 }
228
229
230 /**
231 * <p>
232 * Removes a specific repetition of NTE (Notes and Comments)
233 * </p>
234 *
235 *
236 * @see AbstractGroup#removeRepetition(String, int)
237 */
238 public NTE removeNTE(int rep) throws HL7Exception {
239 return (NTE)super.removeRepetition("NTE", rep);
240 }
241
242
243
244
245 /**
246 * <p>
247 * Returns
248 * QRD (Original-Style Query Definition) - creates it if necessary
249 * </p>
250 *
251 *
252 */
253 public QRD getQRD() {
254 return getTyped("QRD", QRD.class);
255 }
256
257
258
259
260
261 /**
262 * <p>
263 * Returns
264 * QRF (Original Style Query Filter) - creates it if necessary
265 * </p>
266 *
267 *
268 */
269 public QRF getQRF() {
270 return getTyped("QRF", QRF.class);
271 }
272
273
274
275
276
277 /**
278 * <p>
279 * Returns
280 * RESPONSE (a Group object) - creates it if necessary
281 * </p>
282 *
283 *
284 */
285 public OSR_Q06_RESPONSE getRESPONSE() {
286 return getTyped("RESPONSE", OSR_Q06_RESPONSE.class);
287 }
288
289
290
291
292
293 /**
294 * <p>
295 * Returns
296 * DSC (Continuation Pointer) - creates it if necessary
297 * </p>
298 *
299 *
300 */
301 public DSC getDSC() {
302 return getTyped("DSC", DSC.class);
303 }
304
305
306
307
308 }
309