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.v26.group;
35
36 import ca.uhn.hl7v2.model.v26.segment.*;
37
38 import ca.uhn.hl7v2.HL7Exception;
39 import ca.uhn.hl7v2.parser.ModelClassFactory;
40 import ca.uhn.hl7v2.model.*;
41
42 /**
43 * <p>Represents a MFN_M16_MATERIAL_ITEM_RECORD group structure (a Group object).
44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45 * This Group contains the following elements:
46 * </p>
47 * <ul>
48 * <li>1: MFE (Master File Entry) <b> </b></li>
49 * <li>2: ITM (Material Item) <b> </b></li>
50 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li>
51 * <li>4: MFN_M16_STERILIZATION (a Group object) <b>optional repeating </b></li>
52 * <li>5: MFN_M16_PURCHASING_VENDOR (a Group object) <b>optional repeating </b></li>
53 * <li>6: MFN_M16_MATERIAL_LOCATION (a Group object) <b>optional repeating </b></li>
54 * </ul>
55 */
56 //@SuppressWarnings("unused")
57 public class MFN_M16_MATERIAL_ITEM_RECORD extends AbstractGroup {
58
59 /**
60 * Creates a new MFN_M16_MATERIAL_ITEM_RECORD group
61 */
62 public MFN_M16_MATERIAL_ITEM_RECORD(Group parent, ModelClassFactory factory) {
63 super(parent, factory);
64 init(factory);
65 }
66
67 private void init(ModelClassFactory factory) {
68 try {
69 this.add(MFE.class, true, false, false);
70 this.add(ITM.class, true, false, false);
71 this.add(NTE.class, false, true, false);
72 this.add(MFN_M16_STERILIZATION.class, false, true, false);
73 this.add(MFN_M16_PURCHASING_VENDOR.class, false, true, false);
74 this.add(MFN_M16_MATERIAL_LOCATION.class, false, true, false);
75 } catch(HL7Exception e) {
76 log.error("Unexpected error creating MFN_M16_MATERIAL_ITEM_RECORD - this is probably a bug in the source code generator.", e);
77 }
78 }
79
80 /**
81 * Returns "2.6"
82 */
83 public String getVersion() {
84 return "2.6";
85 }
86
87
88
89 /**
90 * Returns
91 * MFE (Master File Entry) - creates it if necessary
92 */
93 public MFE getMFE() {
94 MFE retVal = getTyped("MFE", MFE.class);
95 return retVal;
96 }
97
98
99
100
101 /**
102 * Returns
103 * ITM (Material Item) - creates it if necessary
104 */
105 public ITM getITM() {
106 ITM retVal = getTyped("ITM", ITM.class);
107 return retVal;
108 }
109
110
111
112
113 /**
114 * Returns
115 * the first repetition of
116 * NTE (Notes and Comments) - creates it if necessary
117 */
118 public NTE getNTE() {
119 NTE retVal = getTyped("NTE", NTE.class);
120 return retVal;
121 }
122
123
124 /**
125 * Returns a specific repetition of
126 * NTE (Notes and Comments) - creates it if necessary
127 *
128 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129 * @throws HL7Exception if the repetition requested is more than one
130 * greater than the number of existing repetitions.
131 */
132 public NTE getNTE(int rep) {
133 NTE retVal = getTyped("NTE", rep, NTE.class);
134 return retVal;
135 }
136
137 /**
138 * Returns the number of existing repetitions of NTE
139 */
140 public int getNTEReps() {
141 return getReps("NTE");
142 }
143
144 /**
145 * <p>
146 * Returns a non-modifiable List containing all current existing repetitions of NTE.
147 * <p>
148 * <p>
149 * Note that unlike {@link #getNTE()}, this method will not create any reps
150 * if none are already present, so an empty list may be returned.
151 * </p>
152 */
153 public java.util.List<NTE> getNTEAll() throws HL7Exception {
154 return getAllAsList("NTE", NTE.class);
155 }
156
157 /**
158 * Inserts a specific repetition of NTE (Notes and Comments)
159 * @see AbstractGroup#insertRepetition(Structure, int)
160 */
161 public void insertNTE(NTE structure, int rep) throws HL7Exception {
162 super.insertRepetition("NTE", structure, rep);
163 }
164
165
166 /**
167 * Inserts a specific repetition of NTE (Notes and Comments)
168 * @see AbstractGroup#insertRepetition(Structure, int)
169 */
170 public NTE insertNTE(int rep) throws HL7Exception {
171 return (NTE)super.insertRepetition("NTE", rep);
172 }
173
174
175 /**
176 * Removes a specific repetition of NTE (Notes and Comments)
177 * @see AbstractGroup#removeRepetition(String, int)
178 */
179 public NTE removeNTE(int rep) throws HL7Exception {
180 return (NTE)super.removeRepetition("NTE", rep);
181 }
182
183
184
185 /**
186 * Returns
187 * the first repetition of
188 * STERILIZATION (a Group object) - creates it if necessary
189 */
190 public MFN_M16_STERILIZATION getSTERILIZATION() {
191 MFN_M16_STERILIZATION retVal = getTyped("STERILIZATION", MFN_M16_STERILIZATION.class);
192 return retVal;
193 }
194
195
196 /**
197 * Returns a specific repetition of
198 * STERILIZATION (a Group object) - creates it if necessary
199 *
200 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
201 * @throws HL7Exception if the repetition requested is more than one
202 * greater than the number of existing repetitions.
203 */
204 public MFN_M16_STERILIZATION getSTERILIZATION(int rep) {
205 MFN_M16_STERILIZATION retVal = getTyped("STERILIZATION", rep, MFN_M16_STERILIZATION.class);
206 return retVal;
207 }
208
209 /**
210 * Returns the number of existing repetitions of STERILIZATION
211 */
212 public int getSTERILIZATIONReps() {
213 return getReps("STERILIZATION");
214 }
215
216 /**
217 * <p>
218 * Returns a non-modifiable List containing all current existing repetitions of STERILIZATION.
219 * <p>
220 * <p>
221 * Note that unlike {@link #getSTERILIZATION()}, this method will not create any reps
222 * if none are already present, so an empty list may be returned.
223 * </p>
224 */
225 public java.util.List<MFN_M16_STERILIZATION> getSTERILIZATIONAll() throws HL7Exception {
226 return getAllAsList("STERILIZATION", MFN_M16_STERILIZATION.class);
227 }
228
229 /**
230 * Inserts a specific repetition of STERILIZATION (a Group object)
231 * @see AbstractGroup#insertRepetition(Structure, int)
232 */
233 public void insertSTERILIZATION(MFN_M16_STERILIZATION structure, int rep) throws HL7Exception {
234 super.insertRepetition("STERILIZATION", structure, rep);
235 }
236
237
238 /**
239 * Inserts a specific repetition of STERILIZATION (a Group object)
240 * @see AbstractGroup#insertRepetition(Structure, int)
241 */
242 public MFN_M16_STERILIZATION insertSTERILIZATION(int rep) throws HL7Exception {
243 return (MFN_M16_STERILIZATION)super.insertRepetition("STERILIZATION", rep);
244 }
245
246
247 /**
248 * Removes a specific repetition of STERILIZATION (a Group object)
249 * @see AbstractGroup#removeRepetition(String, int)
250 */
251 public MFN_M16_STERILIZATION removeSTERILIZATION(int rep) throws HL7Exception {
252 return (MFN_M16_STERILIZATION)super.removeRepetition("STERILIZATION", rep);
253 }
254
255
256
257 /**
258 * Returns
259 * the first repetition of
260 * PURCHASING_VENDOR (a Group object) - creates it if necessary
261 */
262 public MFN_M16_PURCHASING_VENDOR getPURCHASING_VENDOR() {
263 MFN_M16_PURCHASING_VENDOR retVal = getTyped("PURCHASING_VENDOR", MFN_M16_PURCHASING_VENDOR.class);
264 return retVal;
265 }
266
267
268 /**
269 * Returns a specific repetition of
270 * PURCHASING_VENDOR (a Group object) - creates it if necessary
271 *
272 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
273 * @throws HL7Exception if the repetition requested is more than one
274 * greater than the number of existing repetitions.
275 */
276 public MFN_M16_PURCHASING_VENDOR getPURCHASING_VENDOR(int rep) {
277 MFN_M16_PURCHASING_VENDOR retVal = getTyped("PURCHASING_VENDOR", rep, MFN_M16_PURCHASING_VENDOR.class);
278 return retVal;
279 }
280
281 /**
282 * Returns the number of existing repetitions of PURCHASING_VENDOR
283 */
284 public int getPURCHASING_VENDORReps() {
285 return getReps("PURCHASING_VENDOR");
286 }
287
288 /**
289 * <p>
290 * Returns a non-modifiable List containing all current existing repetitions of PURCHASING_VENDOR.
291 * <p>
292 * <p>
293 * Note that unlike {@link #getPURCHASING_VENDOR()}, this method will not create any reps
294 * if none are already present, so an empty list may be returned.
295 * </p>
296 */
297 public java.util.List<MFN_M16_PURCHASING_VENDOR> getPURCHASING_VENDORAll() throws HL7Exception {
298 return getAllAsList("PURCHASING_VENDOR", MFN_M16_PURCHASING_VENDOR.class);
299 }
300
301 /**
302 * Inserts a specific repetition of PURCHASING_VENDOR (a Group object)
303 * @see AbstractGroup#insertRepetition(Structure, int)
304 */
305 public void insertPURCHASING_VENDOR(MFN_M16_PURCHASING_VENDOR structure, int rep) throws HL7Exception {
306 super.insertRepetition("PURCHASING_VENDOR", structure, rep);
307 }
308
309
310 /**
311 * Inserts a specific repetition of PURCHASING_VENDOR (a Group object)
312 * @see AbstractGroup#insertRepetition(Structure, int)
313 */
314 public MFN_M16_PURCHASING_VENDOR insertPURCHASING_VENDOR(int rep) throws HL7Exception {
315 return (MFN_M16_PURCHASING_VENDOR)super.insertRepetition("PURCHASING_VENDOR", rep);
316 }
317
318
319 /**
320 * Removes a specific repetition of PURCHASING_VENDOR (a Group object)
321 * @see AbstractGroup#removeRepetition(String, int)
322 */
323 public MFN_M16_PURCHASING_VENDOR removePURCHASING_VENDOR(int rep) throws HL7Exception {
324 return (MFN_M16_PURCHASING_VENDOR)super.removeRepetition("PURCHASING_VENDOR", rep);
325 }
326
327
328
329 /**
330 * Returns
331 * the first repetition of
332 * MATERIAL_LOCATION (a Group object) - creates it if necessary
333 */
334 public MFN_M16_MATERIAL_LOCATION getMATERIAL_LOCATION() {
335 MFN_M16_MATERIAL_LOCATION retVal = getTyped("MATERIAL_LOCATION", MFN_M16_MATERIAL_LOCATION.class);
336 return retVal;
337 }
338
339
340 /**
341 * Returns a specific repetition of
342 * MATERIAL_LOCATION (a Group object) - creates it if necessary
343 *
344 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
345 * @throws HL7Exception if the repetition requested is more than one
346 * greater than the number of existing repetitions.
347 */
348 public MFN_M16_MATERIAL_LOCATION getMATERIAL_LOCATION(int rep) {
349 MFN_M16_MATERIAL_LOCATION retVal = getTyped("MATERIAL_LOCATION", rep, MFN_M16_MATERIAL_LOCATION.class);
350 return retVal;
351 }
352
353 /**
354 * Returns the number of existing repetitions of MATERIAL_LOCATION
355 */
356 public int getMATERIAL_LOCATIONReps() {
357 return getReps("MATERIAL_LOCATION");
358 }
359
360 /**
361 * <p>
362 * Returns a non-modifiable List containing all current existing repetitions of MATERIAL_LOCATION.
363 * <p>
364 * <p>
365 * Note that unlike {@link #getMATERIAL_LOCATION()}, this method will not create any reps
366 * if none are already present, so an empty list may be returned.
367 * </p>
368 */
369 public java.util.List<MFN_M16_MATERIAL_LOCATION> getMATERIAL_LOCATIONAll() throws HL7Exception {
370 return getAllAsList("MATERIAL_LOCATION", MFN_M16_MATERIAL_LOCATION.class);
371 }
372
373 /**
374 * Inserts a specific repetition of MATERIAL_LOCATION (a Group object)
375 * @see AbstractGroup#insertRepetition(Structure, int)
376 */
377 public void insertMATERIAL_LOCATION(MFN_M16_MATERIAL_LOCATION structure, int rep) throws HL7Exception {
378 super.insertRepetition("MATERIAL_LOCATION", structure, rep);
379 }
380
381
382 /**
383 * Inserts a specific repetition of MATERIAL_LOCATION (a Group object)
384 * @see AbstractGroup#insertRepetition(Structure, int)
385 */
386 public MFN_M16_MATERIAL_LOCATION insertMATERIAL_LOCATION(int rep) throws HL7Exception {
387 return (MFN_M16_MATERIAL_LOCATION)super.insertRepetition("MATERIAL_LOCATION", rep);
388 }
389
390
391 /**
392 * Removes a specific repetition of MATERIAL_LOCATION (a Group object)
393 * @see AbstractGroup#removeRepetition(String, int)
394 */
395 public MFN_M16_MATERIAL_LOCATION removeMATERIAL_LOCATION(int rep) throws HL7Exception {
396 return (MFN_M16_MATERIAL_LOCATION)super.removeRepetition("MATERIAL_LOCATION", rep);
397 }
398
399
400
401 }
402