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