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