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 EHC_E01_PROCEDURE 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: PR1 (Procedures) <b> choice</b></li>
49 * <li>2: NTE (Notes and Comments) <b>optional repeating choice</b></li>
50 * <li>3: ROL (Role) <b>optional repeating choice</b></li>
51 * </ul>
52 * <p>
53 * Note that this structure has "choice" elements. This means that one of the
54 * structures above marked as "choice" must be present, but no more than one.
55 * </p>
56 */
57 //@SuppressWarnings("unused")
58 public class EHC_E01_PROCEDURE extends AbstractGroup {
59
60 /**
61 * Creates a new EHC_E01_PROCEDURE group
62 */
63 public EHC_E01_PROCEDURE(Group parent, ModelClassFactory factory) {
64 super(parent, factory);
65 init(factory);
66 }
67
68 private void init(ModelClassFactory factory) {
69 try {
70 this.add(PR1.class, true, false, true);
71 this.add(NTE.class, false, true, true);
72 this.add(ROL.class, false, true, true);
73 } catch(HL7Exception e) {
74 log.error("Unexpected error creating EHC_E01_PROCEDURE - this is probably a bug in the source code generator.", e);
75 }
76 }
77
78 /**
79 * Returns "2.6"
80 */
81 public String getVersion() {
82 return "2.6";
83 }
84
85
86
87 /**
88 * Returns
89 * PR1 (Procedures) - creates it if necessary
90 */
91 public PR1 getPR1() {
92 PR1 retVal = getTyped("PR1", PR1.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 * ROL (Role) - creates it if necessary
175 */
176 public ROL getROL() {
177 ROL retVal = getTyped("ROL", ROL.class);
178 return retVal;
179 }
180
181
182 /**
183 * Returns a specific repetition of
184 * ROL (Role) - 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 ROL getROL(int rep) {
191 ROL retVal = getTyped("ROL", rep, ROL.class);
192 return retVal;
193 }
194
195 /**
196 * Returns the number of existing repetitions of ROL
197 */
198 public int getROLReps() {
199 return getReps("ROL");
200 }
201
202 /**
203 * <p>
204 * Returns a non-modifiable List containing all current existing repetitions of ROL.
205 * <p>
206 * <p>
207 * Note that unlike {@link #getROL()}, 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<ROL> getROLAll() throws HL7Exception {
212 return getAllAsList("ROL", ROL.class);
213 }
214
215 /**
216 * Inserts a specific repetition of ROL (Role)
217 * @see AbstractGroup#insertRepetition(Structure, int)
218 */
219 public void insertROL(ROL structure, int rep) throws HL7Exception {
220 super.insertRepetition("ROL", structure, rep);
221 }
222
223
224 /**
225 * Inserts a specific repetition of ROL (Role)
226 * @see AbstractGroup#insertRepetition(Structure, int)
227 */
228 public ROL insertROL(int rep) throws HL7Exception {
229 return (ROL)super.insertRepetition("ROL", rep);
230 }
231
232
233 /**
234 * Removes a specific repetition of ROL (Role)
235 * @see AbstractGroup#removeRepetition(String, int)
236 */
237 public ROL removeROL(int rep) throws HL7Exception {
238 return (ROL)super.removeRepetition("ROL", rep);
239 }
240
241
242
243 }
244