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.v24.message;
035
036import ca.uhn.hl7v2.model.v24.group.*;
037import ca.uhn.hl7v2.model.v24.segment.*;
038
039import java.util.List;
040
041import ca.uhn.hl7v2.HL7Exception;
042import ca.uhn.hl7v2.parser.ModelClassFactory;
043import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
044import ca.uhn.hl7v2.model.AbstractMessage;
045
046/**
047 * <p>Represents a MFN_M11 message structure (see chapter 8). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message Header) <b> </b></li>
051                 * <li>2: MFI (Master File Identification) <b> </b></li>
052                 * <li>3: MFN_M11_MF_TEST_CALCULATED (a Group object) <b> repeating</b></li>
053 * </ul>
054 */
055@SuppressWarnings("unused")
056public class MFN_M11 extends AbstractMessage  {
057
058    /**
059     * Creates a new MFN_M11 message with DefaultModelClassFactory. 
060     */ 
061    public MFN_M11() { 
062       this(new DefaultModelClassFactory());
063    }
064
065    /** 
066     * Creates a new MFN_M11 message with custom ModelClassFactory.
067     */
068    public MFN_M11(ModelClassFactory factory) {
069       super(factory);
070       init(factory);
071    }
072
073    private void init(ModelClassFactory factory) {
074       try {
075                          this.add(MSH.class, true, false);
076                          this.add(MFI.class, true, false);
077                          this.add(MFN_M11_MF_TEST_CALCULATED.class, true, true);
078       } catch(HL7Exception e) {
079          log.error("Unexpected error creating MFN_M11 - this is probably a bug in the source code generator.", e);
080       }
081    }
082
083    /** 
084     * Returns "2.4"
085     */
086    public String getVersion() {
087       return "2.4";
088    }
089
090
091
092    /**
093     * Returns
094     * MSH (Message Header) - creates it if necessary
095     */
096    public MSH getMSH() { 
097       return getTyped("MSH", MSH.class);
098    }
099
100
101
102
103    /**
104     * Returns
105     * MFI (Master File Identification) - creates it if necessary
106     */
107    public MFI getMFI() { 
108       return getTyped("MFI", MFI.class);
109    }
110
111
112
113
114    /**
115     * Returns
116     * the first repetition of 
117     * MF_TEST_CALCULATED (a Group object) - creates it if necessary
118     */
119    public MFN_M11_MF_TEST_CALCULATED getMF_TEST_CALCULATED() { 
120       return getTyped("MF_TEST_CALCULATED", MFN_M11_MF_TEST_CALCULATED.class);
121    }
122
123
124    /**
125     * Returns a specific repetition of
126     * MF_TEST_CALCULATED (a Group object) - creates it if necessary
127     *
128     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129     * @throws HL7Exception if the repetition requested is more than one 
130     *     greater than the number of existing repetitions.
131     */
132    public MFN_M11_MF_TEST_CALCULATED getMF_TEST_CALCULATED(int rep) { 
133       return getTyped("MF_TEST_CALCULATED", rep, MFN_M11_MF_TEST_CALCULATED.class);
134    }
135
136    /** 
137     * Returns the number of existing repetitions of MF_TEST_CALCULATED 
138     */ 
139    public int getMF_TEST_CALCULATEDReps() { 
140        return getReps("MF_TEST_CALCULATED");
141    } 
142
143    /** 
144     * <p>
145     * Returns a non-modifiable List containing all current existing repetitions of MF_TEST_CALCULATED.
146     * <p>
147     * <p>
148     * Note that unlike {@link #getMF_TEST_CALCULATED()}, this method will not create any reps
149     * if none are already present, so an empty list may be returned.
150     * </p>
151     */ 
152    public List<MFN_M11_MF_TEST_CALCULATED> getMF_TEST_CALCULATEDAll() throws HL7Exception {
153        return getAllAsList("MF_TEST_CALCULATED", MFN_M11_MF_TEST_CALCULATED.class);
154    } 
155
156    /**
157     * Inserts a specific repetition of MF_TEST_CALCULATED (a Group object)
158     * @see AbstractGroup#insertRepetition(Structure, int) 
159     */
160    public void insertMF_TEST_CALCULATED(MFN_M11_MF_TEST_CALCULATED structure, int rep) throws HL7Exception { 
161       super.insertRepetition( "MF_TEST_CALCULATED", structure, rep);
162    }
163
164
165    /**
166     * Inserts a specific repetition of MF_TEST_CALCULATED (a Group object)
167     * @see AbstractGroup#insertRepetition(Structure, int) 
168     */
169    public MFN_M11_MF_TEST_CALCULATED insertMF_TEST_CALCULATED(int rep) throws HL7Exception { 
170       return (MFN_M11_MF_TEST_CALCULATED)super.insertRepetition("MF_TEST_CALCULATED", rep);
171    }
172
173
174    /**
175     * Removes a specific repetition of MF_TEST_CALCULATED (a Group object)
176     * @see AbstractGroup#removeRepetition(String, int) 
177     */
178    public MFN_M11_MF_TEST_CALCULATED removeMF_TEST_CALCULATED(int rep) throws HL7Exception { 
179       return (MFN_M11_MF_TEST_CALCULATED)super.removeRepetition("MF_TEST_CALCULATED", rep);
180    }
181
182
183
184}
185