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 RSP_Z88_COMPONENT 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: RXC (Pharmacy/Treatment Component Order) <b> repeating </b></li>
49 * <li>2: NTE (Notes and Comments) <b>optional repeating </b></li>
50 * </ul>
51 */
52 //@SuppressWarnings("unused")
53 public class RSP_Z88_COMPONENT extends AbstractGroup {
54
55 /**
56 * Creates a new RSP_Z88_COMPONENT group
57 */
58 public RSP_Z88_COMPONENT(Group parent, ModelClassFactory factory) {
59 super(parent, factory);
60 init(factory);
61 }
62
63 private void init(ModelClassFactory factory) {
64 try {
65 this.add(RXC.class, true, true, false);
66 this.add(NTE.class, false, true, false);
67 } catch(HL7Exception e) {
68 log.error("Unexpected error creating RSP_Z88_COMPONENT - this is probably a bug in the source code generator.", e);
69 }
70 }
71
72 /**
73 * Returns "2.6"
74 */
75 public String getVersion() {
76 return "2.6";
77 }
78
79
80
81 /**
82 * Returns
83 * the first repetition of
84 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
85 */
86 public RXC getRXC() {
87 RXC retVal = getTyped("RXC", RXC.class);
88 return retVal;
89 }
90
91
92 /**
93 * Returns a specific repetition of
94 * RXC (Pharmacy/Treatment Component Order) - creates it if necessary
95 *
96 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
97 * @throws HL7Exception if the repetition requested is more than one
98 * greater than the number of existing repetitions.
99 */
100 public RXC getRXC(int rep) {
101 RXC retVal = getTyped("RXC", rep, RXC.class);
102 return retVal;
103 }
104
105 /**
106 * Returns the number of existing repetitions of RXC
107 */
108 public int getRXCReps() {
109 return getReps("RXC");
110 }
111
112 /**
113 * <p>
114 * Returns a non-modifiable List containing all current existing repetitions of RXC.
115 * <p>
116 * <p>
117 * Note that unlike {@link #getRXC()}, this method will not create any reps
118 * if none are already present, so an empty list may be returned.
119 * </p>
120 */
121 public java.util.List<RXC> getRXCAll() throws HL7Exception {
122 return getAllAsList("RXC", RXC.class);
123 }
124
125 /**
126 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
127 * @see AbstractGroup#insertRepetition(Structure, int)
128 */
129 public void insertRXC(RXC structure, int rep) throws HL7Exception {
130 super.insertRepetition("RXC", structure, rep);
131 }
132
133
134 /**
135 * Inserts a specific repetition of RXC (Pharmacy/Treatment Component Order)
136 * @see AbstractGroup#insertRepetition(Structure, int)
137 */
138 public RXC insertRXC(int rep) throws HL7Exception {
139 return (RXC)super.insertRepetition("RXC", rep);
140 }
141
142
143 /**
144 * Removes a specific repetition of RXC (Pharmacy/Treatment Component Order)
145 * @see AbstractGroup#removeRepetition(String, int)
146 */
147 public RXC removeRXC(int rep) throws HL7Exception {
148 return (RXC)super.removeRepetition("RXC", rep);
149 }
150
151
152
153 /**
154 * Returns
155 * the first repetition of
156 * NTE (Notes and Comments) - creates it if necessary
157 */
158 public NTE getNTE() {
159 NTE retVal = getTyped("NTE", NTE.class);
160 return retVal;
161 }
162
163
164 /**
165 * Returns a specific repetition of
166 * NTE (Notes and Comments) - creates it if necessary
167 *
168 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
169 * @throws HL7Exception if the repetition requested is more than one
170 * greater than the number of existing repetitions.
171 */
172 public NTE getNTE(int rep) {
173 NTE retVal = getTyped("NTE", rep, NTE.class);
174 return retVal;
175 }
176
177 /**
178 * Returns the number of existing repetitions of NTE
179 */
180 public int getNTEReps() {
181 return getReps("NTE");
182 }
183
184 /**
185 * <p>
186 * Returns a non-modifiable List containing all current existing repetitions of NTE.
187 * <p>
188 * <p>
189 * Note that unlike {@link #getNTE()}, this method will not create any reps
190 * if none are already present, so an empty list may be returned.
191 * </p>
192 */
193 public java.util.List<NTE> getNTEAll() throws HL7Exception {
194 return getAllAsList("NTE", NTE.class);
195 }
196
197 /**
198 * Inserts a specific repetition of NTE (Notes and Comments)
199 * @see AbstractGroup#insertRepetition(Structure, int)
200 */
201 public void insertNTE(NTE structure, int rep) throws HL7Exception {
202 super.insertRepetition("NTE", structure, rep);
203 }
204
205
206 /**
207 * Inserts a specific repetition of NTE (Notes and Comments)
208 * @see AbstractGroup#insertRepetition(Structure, int)
209 */
210 public NTE insertNTE(int rep) throws HL7Exception {
211 return (NTE)super.insertRepetition("NTE", rep);
212 }
213
214
215 /**
216 * Removes a specific repetition of NTE (Notes and Comments)
217 * @see AbstractGroup#removeRepetition(String, int)
218 */
219 public NTE removeNTE(int rep) throws HL7Exception {
220 return (NTE)super.removeRepetition("NTE", rep);
221 }
222
223
224
225 }
226