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 MFD_M02 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: MFI (MASTER FILE IDENTIFICATION) <b> </b> </li>
051                                 * <li>3: MFA (MASTER FILE ACKNOWLEDGEMENT) <b>optional repeating</b> </li>
052 * </ul>
053 */
054//@SuppressWarnings("unused")
055public class MFD_M02 extends AbstractMessage  {
056
057    /**
058     * Creates a new MFD_M02 message with DefaultModelClassFactory. 
059     */ 
060    public MFD_M02() { 
061       this(new DefaultModelClassFactory());
062    }
063
064    /** 
065     * Creates a new MFD_M02 message with custom ModelClassFactory.
066     */
067    public MFD_M02(ModelClassFactory factory) {
068       super(factory);
069       init(factory);
070    }
071
072    private void init(ModelClassFactory factory) {
073       try {
074                          this.add(MSH.class, true, false);
075                                  this.add(MFI.class, true, false);
076                                  this.add(MFA.class, false, true);
077               } catch(HL7Exception e) {
078          log.error("Unexpected error creating MFD_M02 - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082
083    /** 
084     * Returns "2.2"
085     */
086    public String getVersion() {
087       return "2.2";
088    }
089
090
091
092
093    /**
094     * <p>
095     * Returns
096     * MSH (MESSAGE HEADER) - creates it if necessary
097     * </p>
098     * 
099     *
100     */
101    public MSH getMSH() { 
102       return getTyped("MSH", MSH.class);
103    }
104
105
106
107
108
109    /**
110     * <p>
111     * Returns
112     * MFI (MASTER FILE IDENTIFICATION) - creates it if necessary
113     * </p>
114     * 
115     *
116     */
117    public MFI getMFI() { 
118       return getTyped("MFI", MFI.class);
119    }
120
121
122
123
124
125    /**
126     * <p>
127     * Returns
128     * the first repetition of 
129     * MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary
130     * </p>
131     * 
132     *
133     */
134    public MFA getMFA() { 
135       return getTyped("MFA", MFA.class);
136    }
137
138
139    /**
140     * <p>
141     * Returns a specific repetition of
142     * MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary
143     * </p>
144     * 
145     *
146     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
147     * @throws HL7Exception if the repetition requested is more than one 
148     *     greater than the number of existing repetitions.
149     */
150    public MFA getMFA(int rep) { 
151       return getTyped("MFA", rep, MFA.class);
152    }
153
154    /** 
155     * <p>
156     * Returns the number of existing repetitions of MFA 
157     * </p>
158     * 
159     */ 
160    public int getMFAReps() { 
161        return getReps("MFA");
162    } 
163
164    /** 
165     * <p>
166     * Returns a non-modifiable List containing all current existing repetitions of MFA.
167     * <p>
168     * <p>
169     * Note that unlike {@link #getMFA()}, this method will not create any reps
170     * if none are already present, so an empty list may be returned.
171     * </p>
172     * 
173     */ 
174    public java.util.List<MFA> getMFAAll() throws HL7Exception {
175        return getAllAsList("MFA", MFA.class);
176    } 
177
178    /**
179     * <p>
180     * Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)
181     * </p>
182     * 
183     *
184     * @see AbstractGroup#insertRepetition(Structure, int) 
185     */
186    public void insertMFA(MFA structure, int rep) throws HL7Exception { 
187       super.insertRepetition( "MFA", structure, rep);
188    }
189
190
191    /**
192     * <p>
193     * Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)
194     * </p>
195     * 
196     *
197     * @see AbstractGroup#insertRepetition(Structure, int) 
198     */
199    public MFA insertMFA(int rep) throws HL7Exception { 
200       return (MFA)super.insertRepetition("MFA", rep);
201    }
202
203
204    /**
205     * <p>
206     * Removes a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT)
207     * </p>
208     * 
209     *
210     * @see AbstractGroup#removeRepetition(String, int) 
211     */
212    public MFA removeMFA(int rep) throws HL7Exception { 
213       return (MFA)super.removeRepetition("MFA", rep);
214    }
215
216
217
218}
219