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.v25.message;
35
36 import ca.uhn.hl7v2.model.v25.group.*;
37 import ca.uhn.hl7v2.model.v25.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 UDM_Q05 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: SFT (Software Segment) <b>optional repeating</b> </li>
51 * <li>3: URD (Results/update Definition) <b> </b> </li>
52 * <li>4: URS (Unsolicited Selection) <b>optional </b> </li>
53 * <li>5: DSP (Display Data) <b> repeating</b> </li>
54 * <li>6: DSC (Continuation Pointer) <b>optional </b> </li>
55 * </ul>
56 */
57 //@SuppressWarnings("unused")
58 public class UDM_Q05 extends AbstractMessage {
59
60 /**
61 * Creates a new UDM_Q05 message with DefaultModelClassFactory.
62 */
63 public UDM_Q05() {
64 this(new DefaultModelClassFactory());
65 }
66
67 /**
68 * Creates a new UDM_Q05 message with custom ModelClassFactory.
69 */
70 public UDM_Q05(ModelClassFactory factory) {
71 super(factory);
72 init(factory);
73 }
74
75 private void init(ModelClassFactory factory) {
76 try {
77 this.add(MSH.class, true, false);
78 this.add(SFT.class, false, true);
79 this.add(URD.class, true, false);
80 this.add(URS.class, false, false);
81 this.add(DSP.class, true, true);
82 this.add(DSC.class, false, false);
83 } catch(HL7Exception e) {
84 log.error("Unexpected error creating UDM_Q05 - this is probably a bug in the source code generator.", e);
85 }
86 }
87
88
89 /**
90 * Returns "2.5"
91 */
92 public String getVersion() {
93 return "2.5";
94 }
95
96
97
98
99 /**
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 * the first repetition of
119 * SFT (Software Segment) - creates it if necessary
120 * </p>
121 *
122 *
123 */
124 public SFT getSFT() {
125 return getTyped("SFT", SFT.class);
126 }
127
128
129 /**
130 * <p>
131 * Returns a specific repetition of
132 * SFT (Software Segment) - creates it if necessary
133 * </p>
134 *
135 *
136 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
137 * @throws HL7Exception if the repetition requested is more than one
138 * greater than the number of existing repetitions.
139 */
140 public SFT getSFT(int rep) {
141 return getTyped("SFT", rep, SFT.class);
142 }
143
144 /**
145 * <p>
146 * Returns the number of existing repetitions of SFT
147 * </p>
148 *
149 */
150 public int getSFTReps() {
151 return getReps("SFT");
152 }
153
154 /**
155 * <p>
156 * Returns a non-modifiable List containing all current existing repetitions of SFT.
157 * <p>
158 * <p>
159 * Note that unlike {@link #getSFT()}, this method will not create any reps
160 * if none are already present, so an empty list may be returned.
161 * </p>
162 *
163 */
164 public java.util.List<SFT> getSFTAll() throws HL7Exception {
165 return getAllAsList("SFT", SFT.class);
166 }
167
168 /**
169 * <p>
170 * Inserts a specific repetition of SFT (Software Segment)
171 * </p>
172 *
173 *
174 * @see AbstractGroup#insertRepetition(Structure, int)
175 */
176 public void insertSFT(SFT structure, int rep) throws HL7Exception {
177 super.insertRepetition( "SFT", structure, rep);
178 }
179
180
181 /**
182 * <p>
183 * Inserts a specific repetition of SFT (Software Segment)
184 * </p>
185 *
186 *
187 * @see AbstractGroup#insertRepetition(Structure, int)
188 */
189 public SFT insertSFT(int rep) throws HL7Exception {
190 return (SFT)super.insertRepetition("SFT", rep);
191 }
192
193
194 /**
195 * <p>
196 * Removes a specific repetition of SFT (Software Segment)
197 * </p>
198 *
199 *
200 * @see AbstractGroup#removeRepetition(String, int)
201 */
202 public SFT removeSFT(int rep) throws HL7Exception {
203 return (SFT)super.removeRepetition("SFT", rep);
204 }
205
206
207
208
209 /**
210 * <p>
211 * Returns
212 * URD (Results/update Definition) - creates it if necessary
213 * </p>
214 *
215 *
216 */
217 public URD getURD() {
218 return getTyped("URD", URD.class);
219 }
220
221
222
223
224
225 /**
226 * <p>
227 * Returns
228 * URS (Unsolicited Selection) - creates it if necessary
229 * </p>
230 *
231 *
232 */
233 public URS getURS() {
234 return getTyped("URS", URS.class);
235 }
236
237
238
239
240
241 /**
242 * <p>
243 * Returns
244 * the first repetition of
245 * DSP (Display Data) - creates it if necessary
246 * </p>
247 *
248 *
249 */
250 public DSP getDSP() {
251 return getTyped("DSP", DSP.class);
252 }
253
254
255 /**
256 * <p>
257 * Returns a specific repetition of
258 * DSP (Display Data) - creates it if necessary
259 * </p>
260 *
261 *
262 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
263 * @throws HL7Exception if the repetition requested is more than one
264 * greater than the number of existing repetitions.
265 */
266 public DSP getDSP(int rep) {
267 return getTyped("DSP", rep, DSP.class);
268 }
269
270 /**
271 * <p>
272 * Returns the number of existing repetitions of DSP
273 * </p>
274 *
275 */
276 public int getDSPReps() {
277 return getReps("DSP");
278 }
279
280 /**
281 * <p>
282 * Returns a non-modifiable List containing all current existing repetitions of DSP.
283 * <p>
284 * <p>
285 * Note that unlike {@link #getDSP()}, this method will not create any reps
286 * if none are already present, so an empty list may be returned.
287 * </p>
288 *
289 */
290 public java.util.List<DSP> getDSPAll() throws HL7Exception {
291 return getAllAsList("DSP", DSP.class);
292 }
293
294 /**
295 * <p>
296 * Inserts a specific repetition of DSP (Display Data)
297 * </p>
298 *
299 *
300 * @see AbstractGroup#insertRepetition(Structure, int)
301 */
302 public void insertDSP(DSP structure, int rep) throws HL7Exception {
303 super.insertRepetition( "DSP", structure, rep);
304 }
305
306
307 /**
308 * <p>
309 * Inserts a specific repetition of DSP (Display Data)
310 * </p>
311 *
312 *
313 * @see AbstractGroup#insertRepetition(Structure, int)
314 */
315 public DSP insertDSP(int rep) throws HL7Exception {
316 return (DSP)super.insertRepetition("DSP", rep);
317 }
318
319
320 /**
321 * <p>
322 * Removes a specific repetition of DSP (Display Data)
323 * </p>
324 *
325 *
326 * @see AbstractGroup#removeRepetition(String, int)
327 */
328 public DSP removeDSP(int rep) throws HL7Exception {
329 return (DSP)super.removeRepetition("DSP", rep);
330 }
331
332
333
334
335 /**
336 * <p>
337 * Returns
338 * DSC (Continuation Pointer) - creates it if necessary
339 * </p>
340 *
341 *
342 */
343 public DSC getDSC() {
344 return getTyped("DSC", DSC.class);
345 }
346
347
348
349
350 }
351