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.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 OMD_O01 message structure (see chapter 4.6). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (MSH - message header segment) <b> </b></li>
051                 * <li>2: NTE (NTE - notes and comments segment) <b>optional repeating</b></li>
052                 * <li>3: OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) <b>optional </b></li>
053                 * <li>4: OMD_O01_ORCODSNTEOBXNTE (a Group object) <b> repeating</b></li>
054                 * <li>5: OMD_O01_ORCODTNTE (a Group object) <b>optional repeating</b></li>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class OMD_O01 extends AbstractMessage  {
059
060    /**
061     * Creates a new OMD_O01 message with DefaultModelClassFactory. 
062     */ 
063    public OMD_O01() { 
064       this(new DefaultModelClassFactory());
065    }
066
067    /** 
068     * Creates a new OMD_O01 message with custom ModelClassFactory.
069     */
070    public OMD_O01(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(NTE.class, false, true);
079                          this.add(OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1.class, false, false);
080                          this.add(OMD_O01_ORCODSNTEOBXNTE.class, true, true);
081                          this.add(OMD_O01_ORCODTNTE.class, false, true);
082       } catch(HL7Exception e) {
083          log.error("Unexpected error creating OMD_O01 - 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     * the first repetition of 
110     * NTE (NTE - notes and comments segment) - creates it if necessary
111     */
112    public NTE getNTE() { 
113       return getTyped("NTE", NTE.class);
114    }
115
116
117    /**
118     * Returns a specific repetition of
119     * NTE (NTE - notes and comments segment) - creates it if necessary
120     *
121     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
122     * @throws HL7Exception if the repetition requested is more than one 
123     *     greater than the number of existing repetitions.
124     */
125    public NTE getNTE(int rep) { 
126       return getTyped("NTE", rep, NTE.class);
127    }
128
129    /** 
130     * Returns the number of existing repetitions of NTE 
131     */ 
132    public int getNTEReps() { 
133        return getReps("NTE");
134    } 
135
136    /** 
137     * <p>
138     * Returns a non-modifiable List containing all current existing repetitions of NTE.
139     * <p>
140     * <p>
141     * Note that unlike {@link #getNTE()}, this method will not create any reps
142     * if none are already present, so an empty list may be returned.
143     * </p>
144     */ 
145    public List<NTE> getNTEAll() throws HL7Exception {
146        return getAllAsList("NTE", NTE.class);
147    } 
148
149    /**
150     * Inserts a specific repetition of NTE (NTE - notes and comments segment)
151     * @see AbstractGroup#insertRepetition(Structure, int) 
152     */
153    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
154       super.insertRepetition( "NTE", structure, rep);
155    }
156
157
158    /**
159     * Inserts a specific repetition of NTE (NTE - notes and comments segment)
160     * @see AbstractGroup#insertRepetition(Structure, int) 
161     */
162    public NTE insertNTE(int rep) throws HL7Exception { 
163       return (NTE)super.insertRepetition("NTE", rep);
164    }
165
166
167    /**
168     * Removes a specific repetition of NTE (NTE - notes and comments segment)
169     * @see AbstractGroup#removeRepetition(String, int) 
170     */
171    public NTE removeNTE(int rep) throws HL7Exception { 
172       return (NTE)super.removeRepetition("NTE", rep);
173    }
174
175
176
177    /**
178     * Returns
179     * PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) - creates it if necessary
180     */
181    public OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1() { 
182       return getTyped("PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1", OMD_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1.class);
183    }
184
185
186
187
188    /**
189     * Returns
190     * the first repetition of 
191     * ORCODSNTEOBXNTE (a Group object) - creates it if necessary
192     */
193    public OMD_O01_ORCODSNTEOBXNTE getORCODSNTEOBXNTE() { 
194       return getTyped("ORCODSNTEOBXNTE", OMD_O01_ORCODSNTEOBXNTE.class);
195    }
196
197
198    /**
199     * Returns a specific repetition of
200     * ORCODSNTEOBXNTE (a Group object) - creates it if necessary
201     *
202     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
203     * @throws HL7Exception if the repetition requested is more than one 
204     *     greater than the number of existing repetitions.
205     */
206    public OMD_O01_ORCODSNTEOBXNTE getORCODSNTEOBXNTE(int rep) { 
207       return getTyped("ORCODSNTEOBXNTE", rep, OMD_O01_ORCODSNTEOBXNTE.class);
208    }
209
210    /** 
211     * Returns the number of existing repetitions of ORCODSNTEOBXNTE 
212     */ 
213    public int getORCODSNTEOBXNTEReps() { 
214        return getReps("ORCODSNTEOBXNTE");
215    } 
216
217    /** 
218     * <p>
219     * Returns a non-modifiable List containing all current existing repetitions of ORCODSNTEOBXNTE.
220     * <p>
221     * <p>
222     * Note that unlike {@link #getORCODSNTEOBXNTE()}, this method will not create any reps
223     * if none are already present, so an empty list may be returned.
224     * </p>
225     */ 
226    public List<OMD_O01_ORCODSNTEOBXNTE> getORCODSNTEOBXNTEAll() throws HL7Exception {
227        return getAllAsList("ORCODSNTEOBXNTE", OMD_O01_ORCODSNTEOBXNTE.class);
228    } 
229
230    /**
231     * Inserts a specific repetition of ORCODSNTEOBXNTE (a Group object)
232     * @see AbstractGroup#insertRepetition(Structure, int) 
233     */
234    public void insertORCODSNTEOBXNTE(OMD_O01_ORCODSNTEOBXNTE structure, int rep) throws HL7Exception { 
235       super.insertRepetition( "ORCODSNTEOBXNTE", structure, rep);
236    }
237
238
239    /**
240     * Inserts a specific repetition of ORCODSNTEOBXNTE (a Group object)
241     * @see AbstractGroup#insertRepetition(Structure, int) 
242     */
243    public OMD_O01_ORCODSNTEOBXNTE insertORCODSNTEOBXNTE(int rep) throws HL7Exception { 
244       return (OMD_O01_ORCODSNTEOBXNTE)super.insertRepetition("ORCODSNTEOBXNTE", rep);
245    }
246
247
248    /**
249     * Removes a specific repetition of ORCODSNTEOBXNTE (a Group object)
250     * @see AbstractGroup#removeRepetition(String, int) 
251     */
252    public OMD_O01_ORCODSNTEOBXNTE removeORCODSNTEOBXNTE(int rep) throws HL7Exception { 
253       return (OMD_O01_ORCODSNTEOBXNTE)super.removeRepetition("ORCODSNTEOBXNTE", rep);
254    }
255
256
257
258    /**
259     * Returns
260     * the first repetition of 
261     * ORCODTNTE (a Group object) - creates it if necessary
262     */
263    public OMD_O01_ORCODTNTE getORCODTNTE() { 
264       return getTyped("ORCODTNTE", OMD_O01_ORCODTNTE.class);
265    }
266
267
268    /**
269     * Returns a specific repetition of
270     * ORCODTNTE (a Group object) - creates it if necessary
271     *
272     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
273     * @throws HL7Exception if the repetition requested is more than one 
274     *     greater than the number of existing repetitions.
275     */
276    public OMD_O01_ORCODTNTE getORCODTNTE(int rep) { 
277       return getTyped("ORCODTNTE", rep, OMD_O01_ORCODTNTE.class);
278    }
279
280    /** 
281     * Returns the number of existing repetitions of ORCODTNTE 
282     */ 
283    public int getORCODTNTEReps() { 
284        return getReps("ORCODTNTE");
285    } 
286
287    /** 
288     * <p>
289     * Returns a non-modifiable List containing all current existing repetitions of ORCODTNTE.
290     * <p>
291     * <p>
292     * Note that unlike {@link #getORCODTNTE()}, this method will not create any reps
293     * if none are already present, so an empty list may be returned.
294     * </p>
295     */ 
296    public List<OMD_O01_ORCODTNTE> getORCODTNTEAll() throws HL7Exception {
297        return getAllAsList("ORCODTNTE", OMD_O01_ORCODTNTE.class);
298    } 
299
300    /**
301     * Inserts a specific repetition of ORCODTNTE (a Group object)
302     * @see AbstractGroup#insertRepetition(Structure, int) 
303     */
304    public void insertORCODTNTE(OMD_O01_ORCODTNTE structure, int rep) throws HL7Exception { 
305       super.insertRepetition( "ORCODTNTE", structure, rep);
306    }
307
308
309    /**
310     * Inserts a specific repetition of ORCODTNTE (a Group object)
311     * @see AbstractGroup#insertRepetition(Structure, int) 
312     */
313    public OMD_O01_ORCODTNTE insertORCODTNTE(int rep) throws HL7Exception { 
314       return (OMD_O01_ORCODTNTE)super.insertRepetition("ORCODTNTE", rep);
315    }
316
317
318    /**
319     * Removes a specific repetition of ORCODTNTE (a Group object)
320     * @see AbstractGroup#removeRepetition(String, int) 
321     */
322    public OMD_O01_ORCODTNTE removeORCODTNTE(int rep) throws HL7Exception { 
323       return (OMD_O01_ORCODTNTE)super.removeRepetition("ORCODTNTE", rep);
324    }
325
326
327
328}
329