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