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.message;
035
036import ca.uhn.hl7v2.model.v231.group.*;
037import ca.uhn.hl7v2.model.v231.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 NMR_N01 message structure (see chapter 14). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (MSH - message header segment) <b> </b></li>
051                 * <li>2: MSA (MSA - message acknowledgment segment) <b> </b></li>
052                 * <li>3: ERR (ERR - error segment) <b>optional repeating</b></li>
053                 * <li>4: QRD (QRD - original-style query definition segment) <b>optional </b></li>
054                 * <li>5: NMR_N01_NCKNTENSTNTENSCNTE (a Group object) <b> repeating</b></li>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class NMR_N01 extends AbstractMessage  {
059
060    /**
061     * Creates a new NMR_N01 message with DefaultModelClassFactory. 
062     */ 
063    public NMR_N01() { 
064       this(new DefaultModelClassFactory());
065    }
066
067    /** 
068     * Creates a new NMR_N01 message with custom ModelClassFactory.
069     */
070    public NMR_N01(ModelClassFactory factory) {
071       super(factory);
072       init(factory);
073    }
074
075    private void init(ModelClassFactory factory) {
076       try {
077                          this.add(MSH.class, true, false);
078                          this.add(MSA.class, true, false);
079                          this.add(ERR.class, false, true);
080                          this.add(QRD.class, false, false);
081                          this.add(NMR_N01_NCKNTENSTNTENSCNTE.class, true, true);
082       } catch(HL7Exception e) {
083          log.error("Unexpected error creating NMR_N01 - this is probably a bug in the source code generator.", e);
084       }
085    }
086
087    /** 
088     * Returns "2.3.1"
089     */
090    public String getVersion() {
091       return "2.3.1";
092    }
093
094
095
096    /**
097     * Returns
098     * MSH (MSH - message header segment) - creates it if necessary
099     */
100    public MSH getMSH() { 
101       return getTyped("MSH", MSH.class);
102    }
103
104
105
106
107    /**
108     * Returns
109     * MSA (MSA - message acknowledgment segment) - creates it if necessary
110     */
111    public MSA getMSA() { 
112       return getTyped("MSA", MSA.class);
113    }
114
115
116
117
118    /**
119     * Returns
120     * the first repetition of 
121     * ERR (ERR - error segment) - creates it if necessary
122     */
123    public ERR getERR() { 
124       return getTyped("ERR", ERR.class);
125    }
126
127
128    /**
129     * Returns a specific repetition of
130     * ERR (ERR - error segment) - creates it if necessary
131     *
132     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
133     * @throws HL7Exception if the repetition requested is more than one 
134     *     greater than the number of existing repetitions.
135     */
136    public ERR getERR(int rep) { 
137       return getTyped("ERR", rep, ERR.class);
138    }
139
140    /** 
141     * Returns the number of existing repetitions of ERR 
142     */ 
143    public int getERRReps() { 
144        return getReps("ERR");
145    } 
146
147    /** 
148     * <p>
149     * Returns a non-modifiable List containing all current existing repetitions of ERR.
150     * <p>
151     * <p>
152     * Note that unlike {@link #getERR()}, this method will not create any reps
153     * if none are already present, so an empty list may be returned.
154     * </p>
155     */ 
156    public List<ERR> getERRAll() throws HL7Exception {
157        return getAllAsList("ERR", ERR.class);
158    } 
159
160    /**
161     * Inserts a specific repetition of ERR (ERR - error segment)
162     * @see AbstractGroup#insertRepetition(Structure, int) 
163     */
164    public void insertERR(ERR structure, int rep) throws HL7Exception { 
165       super.insertRepetition( "ERR", structure, rep);
166    }
167
168
169    /**
170     * Inserts a specific repetition of ERR (ERR - error segment)
171     * @see AbstractGroup#insertRepetition(Structure, int) 
172     */
173    public ERR insertERR(int rep) throws HL7Exception { 
174       return (ERR)super.insertRepetition("ERR", rep);
175    }
176
177
178    /**
179     * Removes a specific repetition of ERR (ERR - error segment)
180     * @see AbstractGroup#removeRepetition(String, int) 
181     */
182    public ERR removeERR(int rep) throws HL7Exception { 
183       return (ERR)super.removeRepetition("ERR", rep);
184    }
185
186
187
188    /**
189     * Returns
190     * QRD (QRD - original-style query definition segment) - creates it if necessary
191     */
192    public QRD getQRD() { 
193       return getTyped("QRD", QRD.class);
194    }
195
196
197
198
199    /**
200     * Returns
201     * the first repetition of 
202     * NCKNTENSTNTENSCNTE (a Group object) - creates it if necessary
203     */
204    public NMR_N01_NCKNTENSTNTENSCNTE getNCKNTENSTNTENSCNTE() { 
205       return getTyped("NCKNTENSTNTENSCNTE", NMR_N01_NCKNTENSTNTENSCNTE.class);
206    }
207
208
209    /**
210     * Returns a specific repetition of
211     * NCKNTENSTNTENSCNTE (a Group object) - creates it if necessary
212     *
213     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
214     * @throws HL7Exception if the repetition requested is more than one 
215     *     greater than the number of existing repetitions.
216     */
217    public NMR_N01_NCKNTENSTNTENSCNTE getNCKNTENSTNTENSCNTE(int rep) { 
218       return getTyped("NCKNTENSTNTENSCNTE", rep, NMR_N01_NCKNTENSTNTENSCNTE.class);
219    }
220
221    /** 
222     * Returns the number of existing repetitions of NCKNTENSTNTENSCNTE 
223     */ 
224    public int getNCKNTENSTNTENSCNTEReps() { 
225        return getReps("NCKNTENSTNTENSCNTE");
226    } 
227
228    /** 
229     * <p>
230     * Returns a non-modifiable List containing all current existing repetitions of NCKNTENSTNTENSCNTE.
231     * <p>
232     * <p>
233     * Note that unlike {@link #getNCKNTENSTNTENSCNTE()}, this method will not create any reps
234     * if none are already present, so an empty list may be returned.
235     * </p>
236     */ 
237    public List<NMR_N01_NCKNTENSTNTENSCNTE> getNCKNTENSTNTENSCNTEAll() throws HL7Exception {
238        return getAllAsList("NCKNTENSTNTENSCNTE", NMR_N01_NCKNTENSTNTENSCNTE.class);
239    } 
240
241    /**
242     * Inserts a specific repetition of NCKNTENSTNTENSCNTE (a Group object)
243     * @see AbstractGroup#insertRepetition(Structure, int) 
244     */
245    public void insertNCKNTENSTNTENSCNTE(NMR_N01_NCKNTENSTNTENSCNTE structure, int rep) throws HL7Exception { 
246       super.insertRepetition( "NCKNTENSTNTENSCNTE", structure, rep);
247    }
248
249
250    /**
251     * Inserts a specific repetition of NCKNTENSTNTENSCNTE (a Group object)
252     * @see AbstractGroup#insertRepetition(Structure, int) 
253     */
254    public NMR_N01_NCKNTENSTNTENSCNTE insertNCKNTENSTNTENSCNTE(int rep) throws HL7Exception { 
255       return (NMR_N01_NCKNTENSTNTENSCNTE)super.insertRepetition("NCKNTENSTNTENSCNTE", rep);
256    }
257
258
259    /**
260     * Removes a specific repetition of NCKNTENSTNTENSCNTE (a Group object)
261     * @see AbstractGroup#removeRepetition(String, int) 
262     */
263    public NMR_N01_NCKNTENSTNTENSCNTE removeNCKNTENSTNTENSCNTE(int rep) throws HL7Exception { 
264       return (NMR_N01_NCKNTENSTNTENSCNTE)super.removeRepetition("NCKNTENSTNTENSCNTE", rep);
265    }
266
267
268
269}
270