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 OMN_O01 message structure (see chapter 4.7). 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: OMN_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) <b>optional </b></li>
053                 * <li>4: OMN_O01_ORCRQDRQ1NTEOBXNTEBLG (a Group object) <b> repeating</b></li>
054 * </ul>
055 */
056@SuppressWarnings("unused")
057public class OMN_O01 extends AbstractMessage  {
058
059    /**
060     * Creates a new OMN_O01 message with DefaultModelClassFactory. 
061     */ 
062    public OMN_O01() { 
063       this(new DefaultModelClassFactory());
064    }
065
066    /** 
067     * Creates a new OMN_O01 message with custom ModelClassFactory.
068     */
069    public OMN_O01(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(NTE.class, false, true);
078                          this.add(OMN_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1.class, false, false);
079                          this.add(OMN_O01_ORCRQDRQ1NTEOBXNTEBLG.class, true, true);
080       } catch(HL7Exception e) {
081          log.error("Unexpected error creating OMN_O01 - this is probably a bug in the source code generator.", e);
082       }
083    }
084
085    /** 
086     * Returns "2.3.1"
087     */
088    public String getVersion() {
089       return "2.3.1";
090    }
091
092
093
094    /**
095     * Returns
096     * MSH (MSH - message header segment) - creates it if necessary
097     */
098    public MSH getMSH() { 
099       return getTyped("MSH", MSH.class);
100    }
101
102
103
104
105    /**
106     * Returns
107     * the first repetition of 
108     * NTE (NTE - notes and comments segment) - creates it if necessary
109     */
110    public NTE getNTE() { 
111       return getTyped("NTE", NTE.class);
112    }
113
114
115    /**
116     * Returns a specific repetition of
117     * NTE (NTE - notes and comments segment) - creates it if necessary
118     *
119     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
120     * @throws HL7Exception if the repetition requested is more than one 
121     *     greater than the number of existing repetitions.
122     */
123    public NTE getNTE(int rep) { 
124       return getTyped("NTE", rep, NTE.class);
125    }
126
127    /** 
128     * Returns the number of existing repetitions of NTE 
129     */ 
130    public int getNTEReps() { 
131        return getReps("NTE");
132    } 
133
134    /** 
135     * <p>
136     * Returns a non-modifiable List containing all current existing repetitions of NTE.
137     * <p>
138     * <p>
139     * Note that unlike {@link #getNTE()}, this method will not create any reps
140     * if none are already present, so an empty list may be returned.
141     * </p>
142     */ 
143    public List<NTE> getNTEAll() throws HL7Exception {
144        return getAllAsList("NTE", NTE.class);
145    } 
146
147    /**
148     * Inserts a specific repetition of NTE (NTE - notes and comments segment)
149     * @see AbstractGroup#insertRepetition(Structure, int) 
150     */
151    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
152       super.insertRepetition( "NTE", structure, rep);
153    }
154
155
156    /**
157     * Inserts a specific repetition of NTE (NTE - notes and comments segment)
158     * @see AbstractGroup#insertRepetition(Structure, int) 
159     */
160    public NTE insertNTE(int rep) throws HL7Exception { 
161       return (NTE)super.insertRepetition("NTE", rep);
162    }
163
164
165    /**
166     * Removes a specific repetition of NTE (NTE - notes and comments segment)
167     * @see AbstractGroup#removeRepetition(String, int) 
168     */
169    public NTE removeNTE(int rep) throws HL7Exception { 
170       return (NTE)super.removeRepetition("NTE", rep);
171    }
172
173
174
175    /**
176     * Returns
177     * PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 (a Group object) - creates it if necessary
178     */
179    public OMN_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1 getPIDPD1NTEPV1PV2IN1IN2IN3GT1AL1() { 
180       return getTyped("PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1", OMN_O01_PIDPD1NTEPV1PV2IN1IN2IN3GT1AL1.class);
181    }
182
183
184
185
186    /**
187     * Returns
188     * the first repetition of 
189     * ORCRQDRQ1NTEOBXNTEBLG (a Group object) - creates it if necessary
190     */
191    public OMN_O01_ORCRQDRQ1NTEOBXNTEBLG getORCRQDRQ1NTEOBXNTEBLG() { 
192       return getTyped("ORCRQDRQ1NTEOBXNTEBLG", OMN_O01_ORCRQDRQ1NTEOBXNTEBLG.class);
193    }
194
195
196    /**
197     * Returns a specific repetition of
198     * ORCRQDRQ1NTEOBXNTEBLG (a Group object) - creates it if necessary
199     *
200     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
201     * @throws HL7Exception if the repetition requested is more than one 
202     *     greater than the number of existing repetitions.
203     */
204    public OMN_O01_ORCRQDRQ1NTEOBXNTEBLG getORCRQDRQ1NTEOBXNTEBLG(int rep) { 
205       return getTyped("ORCRQDRQ1NTEOBXNTEBLG", rep, OMN_O01_ORCRQDRQ1NTEOBXNTEBLG.class);
206    }
207
208    /** 
209     * Returns the number of existing repetitions of ORCRQDRQ1NTEOBXNTEBLG 
210     */ 
211    public int getORCRQDRQ1NTEOBXNTEBLGReps() { 
212        return getReps("ORCRQDRQ1NTEOBXNTEBLG");
213    } 
214
215    /** 
216     * <p>
217     * Returns a non-modifiable List containing all current existing repetitions of ORCRQDRQ1NTEOBXNTEBLG.
218     * <p>
219     * <p>
220     * Note that unlike {@link #getORCRQDRQ1NTEOBXNTEBLG()}, this method will not create any reps
221     * if none are already present, so an empty list may be returned.
222     * </p>
223     */ 
224    public List<OMN_O01_ORCRQDRQ1NTEOBXNTEBLG> getORCRQDRQ1NTEOBXNTEBLGAll() throws HL7Exception {
225        return getAllAsList("ORCRQDRQ1NTEOBXNTEBLG", OMN_O01_ORCRQDRQ1NTEOBXNTEBLG.class);
226    } 
227
228    /**
229     * Inserts a specific repetition of ORCRQDRQ1NTEOBXNTEBLG (a Group object)
230     * @see AbstractGroup#insertRepetition(Structure, int) 
231     */
232    public void insertORCRQDRQ1NTEOBXNTEBLG(OMN_O01_ORCRQDRQ1NTEOBXNTEBLG structure, int rep) throws HL7Exception { 
233       super.insertRepetition( "ORCRQDRQ1NTEOBXNTEBLG", structure, rep);
234    }
235
236
237    /**
238     * Inserts a specific repetition of ORCRQDRQ1NTEOBXNTEBLG (a Group object)
239     * @see AbstractGroup#insertRepetition(Structure, int) 
240     */
241    public OMN_O01_ORCRQDRQ1NTEOBXNTEBLG insertORCRQDRQ1NTEOBXNTEBLG(int rep) throws HL7Exception { 
242       return (OMN_O01_ORCRQDRQ1NTEOBXNTEBLG)super.insertRepetition("ORCRQDRQ1NTEOBXNTEBLG", rep);
243    }
244
245
246    /**
247     * Removes a specific repetition of ORCRQDRQ1NTEOBXNTEBLG (a Group object)
248     * @see AbstractGroup#removeRepetition(String, int) 
249     */
250    public OMN_O01_ORCRQDRQ1NTEOBXNTEBLG removeORCRQDRQ1NTEOBXNTEBLG(int rep) throws HL7Exception { 
251       return (OMN_O01_ORCRQDRQ1NTEOBXNTEBLG)super.removeRepetition("ORCRQDRQ1NTEOBXNTEBLG", rep);
252    }
253
254
255
256}
257