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.v231.segment;
035
036// import ca.uhn.hl7v2.model.v231.group.*;
037import ca.uhn.hl7v2.model.v231.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 *<p>Represents an HL7 MFE message segment (MFE - master file entry segment). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>MFE-1: Record-Level Event Code (ID) <b> </b>
052     * <li>MFE-2: MFN Control ID (ST) <b>optional </b>
053     * <li>MFE-3: Effective Date/Time (TS) <b>optional </b>
054     * <li>MFE-4: Primary Key Value - MFE (Varies) <b> repeating</b>
055     * <li>MFE-5: Primary Key Value Type (ID) <b> repeating</b>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class MFE extends AbstractSegment {
060
061    /** 
062     * Creates a new MFE segment
063     */
064    public MFE(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                                              this.add(ID.class, true, 1, 3, new Object[]{ getMessage(), new Integer(180) }, "Record-Level Event Code");
072                                  this.add(ST.class, false, 1, 20, new Object[]{ getMessage() }, "MFN Control ID");
073                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Effective Date/Time");
074                                  this.add(Varies.class, true, 0, 200, new Object[]{ getMessage() }, "Primary Key Value - MFE");
075                                              this.add(ID.class, true, 0, 3, new Object[]{ getMessage(), new Integer(355) }, "Primary Key Value Type");
076       } catch(HL7Exception e) {
077          log.error("Unexpected error creating MFE - this is probably a bug in the source code generator.", e);
078       }
079    }
080
081
082
083    /**
084     * Returns
085     * MFE-1: "Record-Level Event Code" - creates it if necessary
086     */
087    public ID getRecordLevelEventCode() { 
088                ID retVal = this.getTypedField(1, 0);
089                return retVal;
090    }
091    
092    /**
093     * Returns
094     * MFE-1: "Record-Level Event Code" - creates it if necessary
095     */
096    public ID getMfe1_RecordLevelEventCode() { 
097                ID retVal = this.getTypedField(1, 0);
098                return retVal;
099    }
100
101
102
103    /**
104     * Returns
105     * MFE-2: "MFN Control ID" - creates it if necessary
106     */
107    public ST getMFNControlID() { 
108                ST retVal = this.getTypedField(2, 0);
109                return retVal;
110    }
111    
112    /**
113     * Returns
114     * MFE-2: "MFN Control ID" - creates it if necessary
115     */
116    public ST getMfe2_MFNControlID() { 
117                ST retVal = this.getTypedField(2, 0);
118                return retVal;
119    }
120
121
122
123    /**
124     * Returns
125     * MFE-3: "Effective Date/Time" - creates it if necessary
126     */
127    public TS getEffectiveDateTime() { 
128                TS retVal = this.getTypedField(3, 0);
129                return retVal;
130    }
131    
132    /**
133     * Returns
134     * MFE-3: "Effective Date/Time" - creates it if necessary
135     */
136    public TS getMfe3_EffectiveDateTime() { 
137                TS retVal = this.getTypedField(3, 0);
138                return retVal;
139    }
140
141
142    /**
143     * Returns all repetitions of Primary Key Value - MFE (MFE-4).
144     */
145    public Varies[] getPrimaryKeyValueMFE() {
146        Varies[] retVal = this.getTypedField(4, new Varies[0]);
147        return retVal;
148    }
149
150
151    /**
152     * Returns all repetitions of Primary Key Value - MFE (MFE-4).
153     */
154    public Varies[] getMfe4_PrimaryKeyValueMFE() {
155        Varies[] retVal = this.getTypedField(4, new Varies[0]);
156        return retVal;
157    }
158
159
160    /**
161     * Returns a count of the current number of repetitions of Primary Key Value - MFE (MFE-4).
162     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
163     * it will return zero.
164     */
165    public int getPrimaryKeyValueMFEReps() {
166        return this.getReps(4);
167    }
168
169
170    /**
171     * Returns a specific repetition of
172     * MFE-4: "Primary Key Value - MFE" - creates it if necessary
173     *
174     * @param rep The repetition index (0-indexed)
175     */
176    public Varies getPrimaryKeyValueMFE(int rep) { 
177                Varies retVal = this.getTypedField(4, rep);
178                return retVal;
179    }
180
181    /**
182     * Returns a specific repetition of
183     * MFE-4: "Primary Key Value - MFE" - creates it if necessary
184     *
185     * @param rep The repetition index (0-indexed)
186     */
187    public Varies getMfe4_PrimaryKeyValueMFE(int rep) { 
188                Varies retVal = this.getTypedField(4, rep);
189                return retVal;
190    }
191
192    /**
193     * Returns a count of the current number of repetitions of Primary Key Value - MFE (MFE-4).
194     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
195     * it will return zero.
196     */
197    public int getMfe4_PrimaryKeyValueMFEReps() {
198        return this.getReps(4);
199    }
200
201
202    /**
203     * Inserts a repetition of
204     * MFE-4: "Primary Key Value - MFE" at a specific index
205     *
206     * @param rep The repetition index (0-indexed)
207     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
208     */
209    public Varies insertPrimaryKeyValueMFE(int rep) throws HL7Exception { 
210        return (Varies) super.insertRepetition(4, rep);
211    }
212
213
214    /**
215     * Inserts a repetition of
216     * MFE-4: "Primary Key Value - MFE" at a specific index
217     *
218     * @param rep The repetition index (0-indexed)
219     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
220     */
221    public Varies insertMfe4_PrimaryKeyValueMFE(int rep) throws HL7Exception { 
222        return (Varies) super.insertRepetition(4, rep);
223    }
224
225
226    /**
227     * Removes a repetition of
228     * MFE-4: "Primary Key Value - MFE" at a specific index
229     *
230     * @param rep The repetition index (0-indexed)
231     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
232     */
233    public Varies removePrimaryKeyValueMFE(int rep) throws HL7Exception { 
234        return (Varies) super.removeRepetition(4, rep);
235    }
236
237
238    /**
239     * Removes a repetition of
240     * MFE-4: "Primary Key Value - MFE" at a specific index
241     *
242     * @param rep The repetition index (0-indexed)
243     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
244     */
245    public Varies removeMfe4_PrimaryKeyValueMFE(int rep) throws HL7Exception { 
246        return (Varies) super.removeRepetition(4, rep);
247    }
248
249
250
251    /**
252     * Returns all repetitions of Primary Key Value Type (MFE-5).
253     */
254    public ID[] getPrimaryKeyValueType() {
255        ID[] retVal = this.getTypedField(5, new ID[0]);
256        return retVal;
257    }
258
259
260    /**
261     * Returns all repetitions of Primary Key Value Type (MFE-5).
262     */
263    public ID[] getMfe5_PrimaryKeyValueType() {
264        ID[] retVal = this.getTypedField(5, new ID[0]);
265        return retVal;
266    }
267
268
269    /**
270     * Returns a count of the current number of repetitions of Primary Key Value Type (MFE-5).
271     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
272     * it will return zero.
273     */
274    public int getPrimaryKeyValueTypeReps() {
275        return this.getReps(5);
276    }
277
278
279    /**
280     * Returns a specific repetition of
281     * MFE-5: "Primary Key Value Type" - creates it if necessary
282     *
283     * @param rep The repetition index (0-indexed)
284     */
285    public ID getPrimaryKeyValueType(int rep) { 
286                ID retVal = this.getTypedField(5, rep);
287                return retVal;
288    }
289
290    /**
291     * Returns a specific repetition of
292     * MFE-5: "Primary Key Value Type" - creates it if necessary
293     *
294     * @param rep The repetition index (0-indexed)
295     */
296    public ID getMfe5_PrimaryKeyValueType(int rep) { 
297                ID retVal = this.getTypedField(5, rep);
298                return retVal;
299    }
300
301    /**
302     * Returns a count of the current number of repetitions of Primary Key Value Type (MFE-5).
303     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
304     * it will return zero.
305     */
306    public int getMfe5_PrimaryKeyValueTypeReps() {
307        return this.getReps(5);
308    }
309
310
311    /**
312     * Inserts a repetition of
313     * MFE-5: "Primary Key Value Type" at a specific index
314     *
315     * @param rep The repetition index (0-indexed)
316     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
317     */
318    public ID insertPrimaryKeyValueType(int rep) throws HL7Exception { 
319        return (ID) super.insertRepetition(5, rep);
320    }
321
322
323    /**
324     * Inserts a repetition of
325     * MFE-5: "Primary Key Value Type" at a specific index
326     *
327     * @param rep The repetition index (0-indexed)
328     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
329     */
330    public ID insertMfe5_PrimaryKeyValueType(int rep) throws HL7Exception { 
331        return (ID) super.insertRepetition(5, rep);
332    }
333
334
335    /**
336     * Removes a repetition of
337     * MFE-5: "Primary Key Value Type" at a specific index
338     *
339     * @param rep The repetition index (0-indexed)
340     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
341     */
342    public ID removePrimaryKeyValueType(int rep) throws HL7Exception { 
343        return (ID) super.removeRepetition(5, rep);
344    }
345
346
347    /**
348     * Removes a repetition of
349     * MFE-5: "Primary Key Value Type" at a specific index
350     *
351     * @param rep The repetition index (0-indexed)
352     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
353     */
354    public ID removeMfe5_PrimaryKeyValueType(int rep) throws HL7Exception { 
355        return (ID) super.removeRepetition(5, rep);
356    }
357
358
359
360
361
362
363    /** {@inheritDoc} */   
364    protected Type createNewTypeWithoutReflection(int field) {
365       switch (field) {
366          case 0: return new ID(getMessage(), new Integer( 180 ));
367          case 1: return new ST(getMessage());
368          case 2: return new TS(getMessage());
369          case 3: return new Varies(getMessage());
370          case 4: return new ID(getMessage(), new Integer( 355 ));
371          default: return null;
372       }
373   }
374
375
376}
377