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