Source code

001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033
034package ca.uhn.hl7v2.model.v25.segment;
035
036// import ca.uhn.hl7v2.model.v25.group.*;
037import ca.uhn.hl7v2.model.v25.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047
048/**
049 *<p>Represents an HL7 MFA message segment (Master File Acknowledgment). 
050 * This segment has the following fields:</p>
051 * <ul>
052     * <li>MFA-1: Record-Level Event Code (ID) <b> </b>
053     * <li>MFA-2: MFN Control ID (ST) <b>optional </b>
054     * <li>MFA-3: Event Completion Date/Time (TS) <b>optional </b>
055     * <li>MFA-4: MFN Record Level Error Return (CE) <b> </b>
056     * <li>MFA-5: Primary Key Value - MFA (Varies) <b> repeating</b>
057     * <li>MFA-6: Primary Key Value Type - MFA (ID) <b> repeating</b>
058 * </ul>
059 */
060@SuppressWarnings("unused")
061public class MFA extends AbstractSegment {
062
063    /** 
064     * Creates a new MFA segment
065     */
066    public MFA(Group parent, ModelClassFactory factory) {
067       super(parent, factory);
068       init(factory);
069    }
070
071    private void init(ModelClassFactory factory) {
072       try {
073                                              this.add(ID.class, true, 1, 3, new Object[]{ getMessage(), new Integer(180) }, "Record-Level Event Code");
074                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "MFN Control ID");
075                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Event Completion Date/Time");
076                                  this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "MFN Record Level Error Return");
077                                  this.add(Varies.class, true, 0, 250, new Object[]{ getMessage() }, "Primary Key Value - MFA");
078                                              this.add(ID.class, true, 0, 3, new Object[]{ getMessage(), new Integer(355) }, "Primary Key Value Type - MFA");
079       } catch(HL7Exception e) {
080          log.error("Unexpected error creating MFA - this is probably a bug in the source code generator.", e);
081       }
082    }
083
084
085
086    /**
087     * Returns
088     * MFA-1: "Record-Level Event Code" - creates it if necessary
089     */
090    public ID getRecordLevelEventCode() { 
091                ID retVal = this.getTypedField(1, 0);
092                return retVal;
093    }
094    
095    /**
096     * Returns
097     * MFA-1: "Record-Level Event Code" - creates it if necessary
098     */
099    public ID getMfa1_RecordLevelEventCode() { 
100                ID retVal = this.getTypedField(1, 0);
101                return retVal;
102    }
103
104
105
106    /**
107     * Returns
108     * MFA-2: "MFN Control ID" - creates it if necessary
109     */
110    public ST getMFNControlID() { 
111                ST retVal = this.getTypedField(2, 0);
112                return retVal;
113    }
114    
115    /**
116     * Returns
117     * MFA-2: "MFN Control ID" - creates it if necessary
118     */
119    public ST getMfa2_MFNControlID() { 
120                ST retVal = this.getTypedField(2, 0);
121                return retVal;
122    }
123
124
125
126    /**
127     * Returns
128     * MFA-3: "Event Completion Date/Time" - creates it if necessary
129     */
130    public TS getEventCompletionDateTime() { 
131                TS retVal = this.getTypedField(3, 0);
132                return retVal;
133    }
134    
135    /**
136     * Returns
137     * MFA-3: "Event Completion Date/Time" - creates it if necessary
138     */
139    public TS getMfa3_EventCompletionDateTime() { 
140                TS retVal = this.getTypedField(3, 0);
141                return retVal;
142    }
143
144
145
146    /**
147     * Returns
148     * MFA-4: "MFN Record Level Error Return" - creates it if necessary
149     */
150    public CE getMFNRecordLevelErrorReturn() { 
151                CE retVal = this.getTypedField(4, 0);
152                return retVal;
153    }
154    
155    /**
156     * Returns
157     * MFA-4: "MFN Record Level Error Return" - creates it if necessary
158     */
159    public CE getMfa4_MFNRecordLevelErrorReturn() { 
160                CE retVal = this.getTypedField(4, 0);
161                return retVal;
162    }
163
164
165    /**
166     * Returns all repetitions of Primary Key Value - MFA (MFA-5).
167     */
168    public Varies[] getPrimaryKeyValueMFA() {
169        Varies[] retVal = this.getTypedField(5, new Varies[0]);
170        return retVal;
171    }
172
173
174    /**
175     * Returns all repetitions of Primary Key Value - MFA (MFA-5).
176     */
177    public Varies[] getMfa5_PrimaryKeyValueMFA() {
178        Varies[] retVal = this.getTypedField(5, new Varies[0]);
179        return retVal;
180    }
181
182
183    /**
184     * Returns a count of the current number of repetitions of Primary Key Value - MFA (MFA-5).
185     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
186     * it will return zero.
187     */
188    public int getPrimaryKeyValueMFAReps() {
189        return this.getReps(5);
190    }
191
192
193    /**
194     * Returns a specific repetition of
195     * MFA-5: "Primary Key Value - MFA" - creates it if necessary
196     *
197     * @param rep The repetition index (0-indexed)
198     */
199    public Varies getPrimaryKeyValueMFA(int rep) { 
200                Varies retVal = this.getTypedField(5, rep);
201                return retVal;
202    }
203
204    /**
205     * Returns a specific repetition of
206     * MFA-5: "Primary Key Value - MFA" - creates it if necessary
207     *
208     * @param rep The repetition index (0-indexed)
209     */
210    public Varies getMfa5_PrimaryKeyValueMFA(int rep) { 
211                Varies retVal = this.getTypedField(5, rep);
212                return retVal;
213    }
214
215    /**
216     * Returns a count of the current number of repetitions of Primary Key Value - MFA (MFA-5).
217     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
218     * it will return zero.
219     */
220    public int getMfa5_PrimaryKeyValueMFAReps() {
221        return this.getReps(5);
222    }
223
224
225    /**
226     * Inserts a repetition of
227     * MFA-5: "Primary Key Value - MFA" at a specific index
228     *
229     * @param rep The repetition index (0-indexed)
230     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
231     */
232    public Varies insertPrimaryKeyValueMFA(int rep) throws HL7Exception { 
233        return (Varies) super.insertRepetition(5, rep);
234    }
235
236
237    /**
238     * Inserts a repetition of
239     * MFA-5: "Primary Key Value - MFA" at a specific index
240     *
241     * @param rep The repetition index (0-indexed)
242     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
243     */
244    public Varies insertMfa5_PrimaryKeyValueMFA(int rep) throws HL7Exception { 
245        return (Varies) super.insertRepetition(5, rep);
246    }
247
248
249    /**
250     * Removes a repetition of
251     * MFA-5: "Primary Key Value - MFA" at a specific index
252     *
253     * @param rep The repetition index (0-indexed)
254     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
255     */
256    public Varies removePrimaryKeyValueMFA(int rep) throws HL7Exception { 
257        return (Varies) super.removeRepetition(5, rep);
258    }
259
260
261    /**
262     * Removes a repetition of
263     * MFA-5: "Primary Key Value - MFA" at a specific index
264     *
265     * @param rep The repetition index (0-indexed)
266     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
267     */
268    public Varies removeMfa5_PrimaryKeyValueMFA(int rep) throws HL7Exception { 
269        return (Varies) super.removeRepetition(5, rep);
270    }
271
272
273
274    /**
275     * Returns all repetitions of Primary Key Value Type - MFA (MFA-6).
276     */
277    public ID[] getPrimaryKeyValueTypeMFA() {
278        ID[] retVal = this.getTypedField(6, new ID[0]);
279        return retVal;
280    }
281
282
283    /**
284     * Returns all repetitions of Primary Key Value Type - MFA (MFA-6).
285     */
286    public ID[] getMfa6_PrimaryKeyValueTypeMFA() {
287        ID[] retVal = this.getTypedField(6, new ID[0]);
288        return retVal;
289    }
290
291
292    /**
293     * Returns a count of the current number of repetitions of Primary Key Value Type - MFA (MFA-6).
294     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
295     * it will return zero.
296     */
297    public int getPrimaryKeyValueTypeMFAReps() {
298        return this.getReps(6);
299    }
300
301
302    /**
303     * Returns a specific repetition of
304     * MFA-6: "Primary Key Value Type - MFA" - creates it if necessary
305     *
306     * @param rep The repetition index (0-indexed)
307     */
308    public ID getPrimaryKeyValueTypeMFA(int rep) { 
309                ID retVal = this.getTypedField(6, rep);
310                return retVal;
311    }
312
313    /**
314     * Returns a specific repetition of
315     * MFA-6: "Primary Key Value Type - MFA" - creates it if necessary
316     *
317     * @param rep The repetition index (0-indexed)
318     */
319    public ID getMfa6_PrimaryKeyValueTypeMFA(int rep) { 
320                ID retVal = this.getTypedField(6, rep);
321                return retVal;
322    }
323
324    /**
325     * Returns a count of the current number of repetitions of Primary Key Value Type - MFA (MFA-6).
326     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
327     * it will return zero.
328     */
329    public int getMfa6_PrimaryKeyValueTypeMFAReps() {
330        return this.getReps(6);
331    }
332
333
334    /**
335     * Inserts a repetition of
336     * MFA-6: "Primary Key Value Type - MFA" at a specific index
337     *
338     * @param rep The repetition index (0-indexed)
339     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
340     */
341    public ID insertPrimaryKeyValueTypeMFA(int rep) throws HL7Exception { 
342        return (ID) super.insertRepetition(6, rep);
343    }
344
345
346    /**
347     * Inserts a repetition of
348     * MFA-6: "Primary Key Value Type - MFA" at a specific index
349     *
350     * @param rep The repetition index (0-indexed)
351     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
352     */
353    public ID insertMfa6_PrimaryKeyValueTypeMFA(int rep) throws HL7Exception { 
354        return (ID) super.insertRepetition(6, rep);
355    }
356
357
358    /**
359     * Removes a repetition of
360     * MFA-6: "Primary Key Value Type - MFA" at a specific index
361     *
362     * @param rep The repetition index (0-indexed)
363     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
364     */
365    public ID removePrimaryKeyValueTypeMFA(int rep) throws HL7Exception { 
366        return (ID) super.removeRepetition(6, rep);
367    }
368
369
370    /**
371     * Removes a repetition of
372     * MFA-6: "Primary Key Value Type - MFA" at a specific index
373     *
374     * @param rep The repetition index (0-indexed)
375     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
376     */
377    public ID removeMfa6_PrimaryKeyValueTypeMFA(int rep) throws HL7Exception { 
378        return (ID) super.removeRepetition(6, rep);
379    }
380
381
382
383
384
385
386    /** {@inheritDoc} */   
387    protected Type createNewTypeWithoutReflection(int field) {
388       switch (field) {
389          case 0: return new ID(getMessage(), new Integer( 180 ));
390          case 1: return new ST(getMessage());
391          case 2: return new TS(getMessage());
392          case 3: return new CE(getMessage());
393          case 4: return new Varies(getMessage());
394          case 5: return new ID(getMessage(), new Integer( 355 ));
395          default: return null;
396       }
397   }
398
399
400}
401