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.v22.message;
035
036import ca.uhn.hl7v2.model.v22.group.*;
037import ca.uhn.hl7v2.model.v22.segment.*;
038
039import ca.uhn.hl7v2.HL7Exception;
040import ca.uhn.hl7v2.parser.ModelClassFactory;
041import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044
045/**
046 * <p>Represents a MFK_M03 message structure (see chapter ?). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li>
050                                 * <li>2: MSA (MESSAGE ACKNOWLEDGMENT) <b> </b> </li>
051                                 * <li>3: ERR (ERROR) <b>optional </b> </li>
052                                 * <li>4: MFI (MASTER FILE IDENTIFICATION) <b> </b> </li>
053                                 * <li>5: MFA (MASTER FILE ACKNOWLEDGEMENT) <b>optional repeating</b> </li>
054 * </ul>
055 */
056//@SuppressWarnings("unused")
057public class MFK_M03 extends AbstractMessage  {
058
059    /**
060     * Creates a new MFK_M03 message with DefaultModelClassFactory. 
061     */ 
062    public MFK_M03() { 
063       this(new DefaultModelClassFactory());
064    }
065
066    /** 
067     * Creates a new MFK_M03 message with custom ModelClassFactory.
068     */
069    public MFK_M03(ModelClassFactory factory) {
070       super(factory);
071       init(factory);
072    }
073
074    private void init(ModelClassFactory factory) {
075       try {
076                          this.add(MSH.class, true, false);
077                                  this.add(MSA.class, true, false);
078                                  this.add(ERR.class, false, false);
079                                  this.add(MFI.class, true, false);
080                                  this.add(MFA.class, false, true);
081               } catch(HL7Exception e) {
082          log.error("Unexpected error creating MFK_M03 - this is probably a bug in the source code generator.", e);
083       }
084    }
085
086
087    /** 
088     * Returns "2.2"
089     */
090    public String getVersion() {
091       return "2.2";
092    }
093
094
095
096
097    /**
098     * <p>
099     * 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 ACKNOWLEDGEMENT) - 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 ACKNOWLEDGEMENT) - 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 ACKNOWLEDGEMENT)
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 ACKNOWLEDGEMENT)
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 ACKNOWLEDGEMENT)
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