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.v24.message;
35
36 import ca.uhn.hl7v2.model.v24.group.*;
37 import ca.uhn.hl7v2.model.v24.segment.*;
38
39 import ca.uhn.hl7v2.HL7Exception;
40 import ca.uhn.hl7v2.parser.ModelClassFactory;
41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42 import ca.uhn.hl7v2.model.*;
43
44
45 /**
46 * <p>Represents a MFK_M01 message structure (see chapter 8). This structure contains the
47 * following elements: </p>
48 * <ul>
49 * <li>1: MSH (Message Header) <b> </b> </li>
50 * <li>2: MSA (Message Acknowledgment) <b> </b> </li>
51 * <li>3: ERR (Error) <b>optional </b> </li>
52 * <li>4: MFI (Master File Identification) <b> </b> </li>
53 * <li>5: MFA (Master File Acknowledgment) <b>optional repeating</b> </li>
54 * </ul>
55 */
56 //@SuppressWarnings("unused")
57 public class MFK_M01 extends AbstractMessage {
58
59 /**
60 * Creates a new MFK_M01 message with DefaultModelClassFactory.
61 */
62 public MFK_M01() {
63 this(new DefaultModelClassFactory());
64 }
65
66 /**
67 * Creates a new MFK_M01 message with custom ModelClassFactory.
68 */
69 public MFK_M01(ModelClassFactory factory) {
70 super(factory);
71 init(factory);
72 }
73
74 private void init(ModelClassFactory factory) {
75 try {
76 this.add(MSH.class, true, false);
77 this.add(MSA.class, true, false);
78 this.add(ERR.class, false, false);
79 this.add(MFI.class, true, false);
80 this.add(MFA.class, false, true);
81 } catch(HL7Exception e) {
82 log.error("Unexpected error creating MFK_M01 - this is probably a bug in the source code generator.", e);
83 }
84 }
85
86
87 /**
88 * Returns "2.4"
89 */
90 public String getVersion() {
91 return "2.4";
92 }
93
94
95
96
97 /**
98 * <p>
99 * Returns
100 * MSH (Message Header) - creates it if necessary
101 * </p>
102 *
103 *
104 */
105 public MSH getMSH() {
106 return getTyped("MSH", MSH.class);
107 }
108
109
110
111
112
113 /**
114 * <p>
115 * Returns
116 * MSA (Message Acknowledgment) - creates it if necessary
117 * </p>
118 *
119 *
120 */
121 public MSA getMSA() {
122 return getTyped("MSA", MSA.class);
123 }
124
125
126
127
128
129 /**
130 * <p>
131 * Returns
132 * ERR (Error) - creates it if necessary
133 * </p>
134 *
135 *
136 */
137 public ERR getERR() {
138 return getTyped("ERR", ERR.class);
139 }
140
141
142
143
144
145 /**
146 * <p>
147 * Returns
148 * MFI (Master File Identification) - creates it if necessary
149 * </p>
150 *
151 *
152 */
153 public MFI getMFI() {
154 return getTyped("MFI", MFI.class);
155 }
156
157
158
159
160
161 /**
162 * <p>
163 * Returns
164 * the first repetition of
165 * MFA (Master File Acknowledgment) - creates it if necessary
166 * </p>
167 *
168 *
169 */
170 public MFA getMFA() {
171 return getTyped("MFA", MFA.class);
172 }
173
174
175 /**
176 * <p>
177 * Returns a specific repetition of
178 * MFA (Master File Acknowledgment) - creates it if necessary
179 * </p>
180 *
181 *
182 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
183 * @throws HL7Exception if the repetition requested is more than one
184 * greater than the number of existing repetitions.
185 */
186 public MFA getMFA(int rep) {
187 return getTyped("MFA", rep, MFA.class);
188 }
189
190 /**
191 * <p>
192 * Returns the number of existing repetitions of MFA
193 * </p>
194 *
195 */
196 public int getMFAReps() {
197 return getReps("MFA");
198 }
199
200 /**
201 * <p>
202 * Returns a non-modifiable List containing all current existing repetitions of MFA.
203 * <p>
204 * <p>
205 * Note that unlike {@link #getMFA()}, this method will not create any reps
206 * if none are already present, so an empty list may be returned.
207 * </p>
208 *
209 */
210 public java.util.List<MFA> getMFAAll() throws HL7Exception {
211 return getAllAsList("MFA", MFA.class);
212 }
213
214 /**
215 * <p>
216 * Inserts a specific repetition of MFA (Master File Acknowledgment)
217 * </p>
218 *
219 *
220 * @see AbstractGroup#insertRepetition(Structure, int)
221 */
222 public void insertMFA(MFA structure, int rep) throws HL7Exception {
223 super.insertRepetition( "MFA", structure, rep);
224 }
225
226
227 /**
228 * <p>
229 * Inserts a specific repetition of MFA (Master File Acknowledgment)
230 * </p>
231 *
232 *
233 * @see AbstractGroup#insertRepetition(Structure, int)
234 */
235 public MFA insertMFA(int rep) throws HL7Exception {
236 return (MFA)super.insertRepetition("MFA", rep);
237 }
238
239
240 /**
241 * <p>
242 * Removes a specific repetition of MFA (Master File Acknowledgment)
243 * </p>
244 *
245 *
246 * @see AbstractGroup#removeRepetition(String, int)
247 */
248 public MFA removeMFA(int rep) throws HL7Exception {
249 return (MFA)super.removeRepetition("MFA", rep);
250 }
251
252
253
254 }
255