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 CCR_I16_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: VAR (Variance) <b>optional repeating </b></li>
50 * <li>3: CCR_I16_ROLE_GOAL (a Group object) <b>optional repeating </b></li>
51 * <li>4: CCR_I16_GOAL_OBSERVATION (a Group object) <b>optional repeating </b></li>
52 * </ul>
53 */
54 //@SuppressWarnings("unused")
55 public class CCR_I16_GOAL extends AbstractGroup {
56
57 /**
58 * Creates a new CCR_I16_GOAL group
59 */
60 public CCR_I16_GOAL(Group parent, ModelClassFactory factory) {
61 super(parent, factory);
62 init(factory);
63 }
64
65 private void init(ModelClassFactory factory) {
66 try {
67 this.add(GOL.class, true, false, false);
68 this.add(VAR.class, false, true, false);
69 this.add(CCR_I16_ROLE_GOAL.class, false, true, false);
70 this.add(CCR_I16_GOAL_OBSERVATION.class, false, true, false);
71 } catch(HL7Exception e) {
72 log.error("Unexpected error creating CCR_I16_GOAL - this is probably a bug in the source code generator.", e);
73 }
74 }
75
76 /**
77 * Returns "2.8"
78 */
79 public String getVersion() {
80 return "2.8";
81 }
82
83
84
85 /**
86 * Returns
87 * GOL (Goal Detail) - creates it if necessary
88 */
89 public GOL getGOL() {
90 GOL retVal = getTyped("GOL", GOL.class);
91 return retVal;
92 }
93
94
95
96
97 /**
98 * Returns
99 * the first repetition of
100 * VAR (Variance) - creates it if necessary
101 */
102 public VAR getVAR() {
103 VAR retVal = getTyped("VAR", VAR.class);
104 return retVal;
105 }
106
107
108 /**
109 * Returns a specific repetition of
110 * VAR (Variance) - 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 VAR getVAR(int rep) {
117 VAR retVal = getTyped("VAR", rep, VAR.class);
118 return retVal;
119 }
120
121 /**
122 * Returns the number of existing repetitions of VAR
123 */
124 public int getVARReps() {
125 return getReps("VAR");
126 }
127
128 /**
129 * <p>
130 * Returns a non-modifiable List containing all current existing repetitions of VAR.
131 * <p>
132 * <p>
133 * Note that unlike {@link #getVAR()}, 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<VAR> getVARAll() throws HL7Exception {
138 return getAllAsList("VAR", VAR.class);
139 }
140
141 /**
142 * Inserts a specific repetition of VAR (Variance)
143 * @see AbstractGroup#insertRepetition(Structure, int)
144 */
145 public void insertVAR(VAR structure, int rep) throws HL7Exception {
146 super.insertRepetition("VAR", structure, rep);
147 }
148
149
150 /**
151 * Inserts a specific repetition of VAR (Variance)
152 * @see AbstractGroup#insertRepetition(Structure, int)
153 */
154 public VAR insertVAR(int rep) throws HL7Exception {
155 return (VAR)super.insertRepetition("VAR", rep);
156 }
157
158
159 /**
160 * Removes a specific repetition of VAR (Variance)
161 * @see AbstractGroup#removeRepetition(String, int)
162 */
163 public VAR removeVAR(int rep) throws HL7Exception {
164 return (VAR)super.removeRepetition("VAR", rep);
165 }
166
167
168
169 /**
170 * Returns
171 * the first repetition of
172 * ROLE_GOAL (a Group object) - creates it if necessary
173 */
174 public CCR_I16_ROLE_GOAL getROLE_GOAL() {
175 CCR_I16_ROLE_GOAL retVal = getTyped("ROLE_GOAL", CCR_I16_ROLE_GOAL.class);
176 return retVal;
177 }
178
179
180 /**
181 * Returns a specific repetition of
182 * ROLE_GOAL (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 CCR_I16_ROLE_GOAL getROLE_GOAL(int rep) {
189 CCR_I16_ROLE_GOAL retVal = getTyped("ROLE_GOAL", rep, CCR_I16_ROLE_GOAL.class);
190 return retVal;
191 }
192
193 /**
194 * Returns the number of existing repetitions of ROLE_GOAL
195 */
196 public int getROLE_GOALReps() {
197 return getReps("ROLE_GOAL");
198 }
199
200 /**
201 * <p>
202 * Returns a non-modifiable List containing all current existing repetitions of ROLE_GOAL.
203 * <p>
204 * <p>
205 * Note that unlike {@link #getROLE_GOAL()}, 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<CCR_I16_ROLE_GOAL> getROLE_GOALAll() throws HL7Exception {
210 return getAllAsList("ROLE_GOAL", CCR_I16_ROLE_GOAL.class);
211 }
212
213 /**
214 * Inserts a specific repetition of ROLE_GOAL (a Group object)
215 * @see AbstractGroup#insertRepetition(Structure, int)
216 */
217 public void insertROLE_GOAL(CCR_I16_ROLE_GOAL structure, int rep) throws HL7Exception {
218 super.insertRepetition("ROLE_GOAL", structure, rep);
219 }
220
221
222 /**
223 * Inserts a specific repetition of ROLE_GOAL (a Group object)
224 * @see AbstractGroup#insertRepetition(Structure, int)
225 */
226 public CCR_I16_ROLE_GOAL insertROLE_GOAL(int rep) throws HL7Exception {
227 return (CCR_I16_ROLE_GOAL)super.insertRepetition("ROLE_GOAL", rep);
228 }
229
230
231 /**
232 * Removes a specific repetition of ROLE_GOAL (a Group object)
233 * @see AbstractGroup#removeRepetition(String, int)
234 */
235 public CCR_I16_ROLE_GOAL removeROLE_GOAL(int rep) throws HL7Exception {
236 return (CCR_I16_ROLE_GOAL)super.removeRepetition("ROLE_GOAL", rep);
237 }
238
239
240
241 /**
242 * Returns
243 * the first repetition of
244 * GOAL_OBSERVATION (a Group object) - creates it if necessary
245 */
246 public CCR_I16_GOAL_OBSERVATION getGOAL_OBSERVATION() {
247 CCR_I16_GOAL_OBSERVATION retVal = getTyped("GOAL_OBSERVATION", CCR_I16_GOAL_OBSERVATION.class);
248 return retVal;
249 }
250
251
252 /**
253 * Returns a specific repetition of
254 * GOAL_OBSERVATION (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 CCR_I16_GOAL_OBSERVATION getGOAL_OBSERVATION(int rep) {
261 CCR_I16_GOAL_OBSERVATION retVal = getTyped("GOAL_OBSERVATION", rep, CCR_I16_GOAL_OBSERVATION.class);
262 return retVal;
263 }
264
265 /**
266 * Returns the number of existing repetitions of GOAL_OBSERVATION
267 */
268 public int getGOAL_OBSERVATIONReps() {
269 return getReps("GOAL_OBSERVATION");
270 }
271
272 /**
273 * <p>
274 * Returns a non-modifiable List containing all current existing repetitions of GOAL_OBSERVATION.
275 * <p>
276 * <p>
277 * Note that unlike {@link #getGOAL_OBSERVATION()}, 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<CCR_I16_GOAL_OBSERVATION> getGOAL_OBSERVATIONAll() throws HL7Exception {
282 return getAllAsList("GOAL_OBSERVATION", CCR_I16_GOAL_OBSERVATION.class);
283 }
284
285 /**
286 * Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
287 * @see AbstractGroup#insertRepetition(Structure, int)
288 */
289 public void insertGOAL_OBSERVATION(CCR_I16_GOAL_OBSERVATION structure, int rep) throws HL7Exception {
290 super.insertRepetition("GOAL_OBSERVATION", structure, rep);
291 }
292
293
294 /**
295 * Inserts a specific repetition of GOAL_OBSERVATION (a Group object)
296 * @see AbstractGroup#insertRepetition(Structure, int)
297 */
298 public CCR_I16_GOAL_OBSERVATION insertGOAL_OBSERVATION(int rep) throws HL7Exception {
299 return (CCR_I16_GOAL_OBSERVATION)super.insertRepetition("GOAL_OBSERVATION", rep);
300 }
301
302
303 /**
304 * Removes a specific repetition of GOAL_OBSERVATION (a Group object)
305 * @see AbstractGroup#removeRepetition(String, int)
306 */
307 public CCR_I16_GOAL_OBSERVATION removeGOAL_OBSERVATION(int rep) throws HL7Exception {
308 return (CCR_I16_GOAL_OBSERVATION)super.removeRepetition("GOAL_OBSERVATION", rep);
309 }
310
311
312
313 }
314