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.v28.group;
35
36 import ca.uhn.hl7v2.model.v28.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_M08_MF_TEST_NUMERIC 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: OM1 (General Segment) <b> </b></li>
50 * <li>3: PRT (Participation Information) <b>optional repeating </b></li>
51 * <li>4: OM2 (Numeric Observation) <b>optional </b></li>
52 * <li>5: OM3 (Categorical Service/Test/Observation) <b>optional </b></li>
53 * <li>6: OM4 (Observations that Require Specimens) <b>optional repeating </b></li>
54 * </ul>
55 */
56 //@SuppressWarnings("unused")
57 public class MFN_M08_MF_TEST_NUMERIC extends AbstractGroup {
58
59 /**
60 * Creates a new MFN_M08_MF_TEST_NUMERIC group
61 */
62 public MFN_M08_MF_TEST_NUMERIC(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(OM1.class, true, false, false);
71 this.add(PRT.class, false, true, false);
72 this.add(OM2.class, false, false, false);
73 this.add(OM3.class, false, false, false);
74 this.add(OM4.class, false, true, false);
75 } catch(HL7Exception e) {
76 log.error("Unexpected error creating MFN_M08_MF_TEST_NUMERIC - this is probably a bug in the source code generator.", e);
77 }
78 }
79
80 /**
81 * Returns "2.8"
82 */
83 public String getVersion() {
84 return "2.8";
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 * OM1 (General Segment) - creates it if necessary
104 */
105 public OM1 getOM1() {
106 OM1 retVal = getTyped("OM1", OM1.class);
107 return retVal;
108 }
109
110
111
112
113 /**
114 * Returns
115 * the first repetition of
116 * PRT (Participation Information) - creates it if necessary
117 */
118 public PRT getPRT() {
119 PRT retVal = getTyped("PRT", PRT.class);
120 return retVal;
121 }
122
123
124 /**
125 * Returns a specific repetition of
126 * PRT (Participation Information) - 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 PRT getPRT(int rep) {
133 PRT retVal = getTyped("PRT", rep, PRT.class);
134 return retVal;
135 }
136
137 /**
138 * Returns the number of existing repetitions of PRT
139 */
140 public int getPRTReps() {
141 return getReps("PRT");
142 }
143
144 /**
145 * <p>
146 * Returns a non-modifiable List containing all current existing repetitions of PRT.
147 * <p>
148 * <p>
149 * Note that unlike {@link #getPRT()}, 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<PRT> getPRTAll() throws HL7Exception {
154 return getAllAsList("PRT", PRT.class);
155 }
156
157 /**
158 * Inserts a specific repetition of PRT (Participation Information)
159 * @see AbstractGroup#insertRepetition(Structure, int)
160 */
161 public void insertPRT(PRT structure, int rep) throws HL7Exception {
162 super.insertRepetition("PRT", structure, rep);
163 }
164
165
166 /**
167 * Inserts a specific repetition of PRT (Participation Information)
168 * @see AbstractGroup#insertRepetition(Structure, int)
169 */
170 public PRT insertPRT(int rep) throws HL7Exception {
171 return (PRT)super.insertRepetition("PRT", rep);
172 }
173
174
175 /**
176 * Removes a specific repetition of PRT (Participation Information)
177 * @see AbstractGroup#removeRepetition(String, int)
178 */
179 public PRT removePRT(int rep) throws HL7Exception {
180 return (PRT)super.removeRepetition("PRT", rep);
181 }
182
183
184
185 /**
186 * Returns
187 * OM2 (Numeric Observation) - creates it if necessary
188 */
189 public OM2 getOM2() {
190 OM2 retVal = getTyped("OM2", OM2.class);
191 return retVal;
192 }
193
194
195
196
197 /**
198 * Returns
199 * OM3 (Categorical Service/Test/Observation) - creates it if necessary
200 */
201 public OM3 getOM3() {
202 OM3 retVal = getTyped("OM3", OM3.class);
203 return retVal;
204 }
205
206
207
208
209 /**
210 * Returns
211 * the first repetition of
212 * OM4 (Observations that Require Specimens) - creates it if necessary
213 */
214 public OM4 getOM4() {
215 OM4 retVal = getTyped("OM4", OM4.class);
216 return retVal;
217 }
218
219
220 /**
221 * Returns a specific repetition of
222 * OM4 (Observations that Require Specimens) - creates it if necessary
223 *
224 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
225 * @throws HL7Exception if the repetition requested is more than one
226 * greater than the number of existing repetitions.
227 */
228 public OM4 getOM4(int rep) {
229 OM4 retVal = getTyped("OM4", rep, OM4.class);
230 return retVal;
231 }
232
233 /**
234 * Returns the number of existing repetitions of OM4
235 */
236 public int getOM4Reps() {
237 return getReps("OM4");
238 }
239
240 /**
241 * <p>
242 * Returns a non-modifiable List containing all current existing repetitions of OM4.
243 * <p>
244 * <p>
245 * Note that unlike {@link #getOM4()}, this method will not create any reps
246 * if none are already present, so an empty list may be returned.
247 * </p>
248 */
249 public java.util.List<OM4> getOM4All() throws HL7Exception {
250 return getAllAsList("OM4", OM4.class);
251 }
252
253 /**
254 * Inserts a specific repetition of OM4 (Observations that Require Specimens)
255 * @see AbstractGroup#insertRepetition(Structure, int)
256 */
257 public void insertOM4(OM4 structure, int rep) throws HL7Exception {
258 super.insertRepetition("OM4", structure, rep);
259 }
260
261
262 /**
263 * Inserts a specific repetition of OM4 (Observations that Require Specimens)
264 * @see AbstractGroup#insertRepetition(Structure, int)
265 */
266 public OM4 insertOM4(int rep) throws HL7Exception {
267 return (OM4)super.insertRepetition("OM4", rep);
268 }
269
270
271 /**
272 * Removes a specific repetition of OM4 (Observations that Require Specimens)
273 * @see AbstractGroup#removeRepetition(String, int)
274 */
275 public OM4 removeOM4(int rep) throws HL7Exception {
276 return (OM4)super.removeRepetition("OM4", rep);
277 }
278
279
280
281 }
282