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.v25.group;
035
036import ca.uhn.hl7v2.model.v25.segment.*;
037
038import java.util.List;
039
040import ca.uhn.hl7v2.HL7Exception;
041import ca.uhn.hl7v2.parser.ModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044/**
045 * <p>Represents a NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT group structure (a Group object).
046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
047 * This Group contains the following elements:  
048 * </p>
049 * <ul>
050                 * <li>1: NCK (System Clock) <b>optional </b></li>
051                 * <li>2: NTE (Notes and Comments) <b>optional repeating</b></li>
052                 * <li>3: NST (Application control level statistics) <b>optional </b></li>
053                 * <li>4: NTE (Notes and Comments) <b>optional repeating</b></li>
054                 * <li>5: NSC (Application Status Change) <b>optional </b></li>
055                 * <li>6: NTE (Notes and Comments) <b>optional repeating</b></li>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT extends AbstractGroup {
060
061    /** 
062     * Creates a new NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT group
063     */
064    public NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                          this.add(NCK.class, false, false);
072                          this.add(NTE.class, false, true);
073                          this.add(NST.class, false, false);
074                          this.add(NTE.class, false, true);
075                          this.add(NSC.class, false, false);
076                          this.add(NTE.class, false, true);
077       } catch(HL7Exception e) {
078          log.error("Unexpected error creating NMR_N01_CLOCK_AND_STATS_WITH_NOTES_ALT - this is probably a bug in the source code generator.", e);
079       }
080    }
081
082    /** 
083     * Returns "2.5"
084     */
085    public String getVersion() {
086       return "2.5";
087    }
088
089
090
091    /**
092     * Returns
093     * NCK (System Clock) - creates it if necessary
094     */
095    public NCK getNCK() { 
096       NCK retVal = getTyped("NCK", NCK.class);
097       return retVal;
098    }
099
100
101
102
103    /**
104     * Returns
105     * the first repetition of 
106     * NTE (Notes and Comments) - creates it if necessary
107     */
108    public NTE getNTE() { 
109       NTE retVal = getTyped("NTE", NTE.class);
110       return retVal;
111    }
112
113
114    /**
115     * Returns a specific repetition of
116     * NTE (Notes and Comments) - creates it if necessary
117     *
118     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
119     * @throws HL7Exception if the repetition requested is more than one 
120     *     greater than the number of existing repetitions.
121     */
122    public NTE getNTE(int rep) { 
123       NTE retVal = getTyped("NTE", rep, NTE.class);
124       return retVal;
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 (Notes and Comments)
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 (Notes and Comments)
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 (Notes and Comments)
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     * NST (Application control level statistics) - creates it if necessary
178     */
179    public NST getNST() { 
180       NST retVal = getTyped("NST", NST.class);
181       return retVal;
182    }
183
184
185
186
187    /**
188     * Returns
189     * the first repetition of 
190     * NTE2 (Notes and Comments) - creates it if necessary
191     */
192    public NTE getNTE2() { 
193       NTE retVal = getTyped("NTE2", NTE.class);
194       return retVal;
195    }
196
197
198    /**
199     * Returns a specific repetition of
200     * NTE (Notes and Comments) - 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 NTE getNTE2(int rep) { 
207       NTE retVal = getTyped("NTE2", rep, NTE.class);
208       return retVal;
209    }
210
211    /** 
212     * Returns the number of existing repetitions of NTE2 
213     */ 
214    public int getNTE2Reps() {  
215        return getReps("NTE2");
216    } 
217
218    /** 
219     * <p>
220     * Returns a non-modifiable List containing all current existing repetitions of NTE2.
221     * <p>
222     * <p>
223     * Note that unlike {@link #getNTE2()}, this method will not create any reps
224     * if none are already present, so an empty list may be returned.
225     * </p>
226     */ 
227    public List<NTE> getNTE2All() throws HL7Exception {
228        return getAllAsList("NTE2", NTE.class);
229    } 
230
231    /**
232     * Inserts a specific repetition of NTE2 (Notes and Comments)
233     * @see AbstractGroup#insertRepetition(Structure, int) 
234     */
235    public void insertNTE2(NTE structure, int rep) throws HL7Exception { 
236       super.insertRepetition("NTE2", structure, rep);
237    }
238
239
240    /**
241     * Inserts a specific repetition of NTE2 (Notes and Comments)
242     * @see AbstractGroup#insertRepetition(Structure, int) 
243     */
244    public NTE insertNTE2(int rep) throws HL7Exception { 
245       return (NTE)super.insertRepetition("NTE2", rep);
246    }
247
248
249    /**
250     * Removes a specific repetition of NTE2 (Notes and Comments)
251     * @see AbstractGroup#removeRepetition(String, int) 
252     */
253    public NTE removeNTE2(int rep) throws HL7Exception { 
254       return (NTE)super.removeRepetition("NTE2", rep);
255    }
256
257
258
259    /**
260     * Returns
261     * NSC (Application Status Change) - creates it if necessary
262     */
263    public NSC getNSC() { 
264       NSC retVal = getTyped("NSC", NSC.class);
265       return retVal;
266    }
267
268
269
270
271    /**
272     * Returns
273     * the first repetition of 
274     * NTE3 (Notes and Comments) - creates it if necessary
275     */
276    public NTE getNTE3() { 
277       NTE retVal = getTyped("NTE3", NTE.class);
278       return retVal;
279    }
280
281
282    /**
283     * Returns a specific repetition of
284     * NTE (Notes and Comments) - creates it if necessary
285     *
286     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
287     * @throws HL7Exception if the repetition requested is more than one 
288     *     greater than the number of existing repetitions.
289     */
290    public NTE getNTE3(int rep) { 
291       NTE retVal = getTyped("NTE3", rep, NTE.class);
292       return retVal;
293    }
294
295    /** 
296     * Returns the number of existing repetitions of NTE3 
297     */ 
298    public int getNTE3Reps() {  
299        return getReps("NTE3");
300    } 
301
302    /** 
303     * <p>
304     * Returns a non-modifiable List containing all current existing repetitions of NTE3.
305     * <p>
306     * <p>
307     * Note that unlike {@link #getNTE3()}, this method will not create any reps
308     * if none are already present, so an empty list may be returned.
309     * </p>
310     */ 
311    public List<NTE> getNTE3All() throws HL7Exception {
312        return getAllAsList("NTE3", NTE.class);
313    } 
314
315    /**
316     * Inserts a specific repetition of NTE3 (Notes and Comments)
317     * @see AbstractGroup#insertRepetition(Structure, int) 
318     */
319    public void insertNTE3(NTE structure, int rep) throws HL7Exception { 
320       super.insertRepetition("NTE3", structure, rep);
321    }
322
323
324    /**
325     * Inserts a specific repetition of NTE3 (Notes and Comments)
326     * @see AbstractGroup#insertRepetition(Structure, int) 
327     */
328    public NTE insertNTE3(int rep) throws HL7Exception { 
329       return (NTE)super.insertRepetition("NTE3", rep);
330    }
331
332
333    /**
334     * Removes a specific repetition of NTE3 (Notes and Comments)
335     * @see AbstractGroup#removeRepetition(String, int) 
336     */
337    public NTE removeNTE3(int rep) throws HL7Exception { 
338       return (NTE)super.removeRepetition("NTE3", rep);
339    }
340
341
342
343}
344