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.group;
035
036import ca.uhn.hl7v2.model.v231.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a RGV_O01_RXCNTE 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: RXC (RXC - pharmacy/treatment component order segment) <b> repeating </b></li>
049                         * <li>2: NTE (NTE - notes and comments segment) <b>optional repeating </b></li>
050 * </ul>
051 */
052//@SuppressWarnings("unused")
053public class RGV_O01_RXCNTE extends AbstractGroup {
054
055    /** 
056     * Creates a new RGV_O01_RXCNTE group
057     */
058    public RGV_O01_RXCNTE(Group parent, ModelClassFactory factory) {
059       super(parent, factory);
060       init(factory);
061    }
062
063    private void init(ModelClassFactory factory) {
064       try {
065                                  this.add(RXC.class, true, true, false);
066                                  this.add(NTE.class, false, true, false);
067       } catch(HL7Exception e) {
068          log.error("Unexpected error creating RGV_O01_RXCNTE - this is probably a bug in the source code generator.", e);
069       }
070    }
071
072    /** 
073     * Returns "2.3.1"
074     */
075    public String getVersion() {
076       return "2.3.1";
077    }
078
079
080
081    /**
082     * Returns
083     * the first repetition of 
084     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
085     */
086    public RXC getRXC() { 
087       RXC retVal = getTyped("RXC", RXC.class);
088       return retVal;
089    }
090
091
092    /**
093     * Returns a specific repetition of
094     * RXC (RXC - pharmacy/treatment component order segment) - creates it if necessary
095     *
096     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
097     * @throws HL7Exception if the repetition requested is more than one 
098     *     greater than the number of existing repetitions.
099     */
100    public RXC getRXC(int rep) { 
101       RXC retVal = getTyped("RXC", rep, RXC.class);
102       return retVal;
103    }
104
105    /** 
106     * Returns the number of existing repetitions of RXC 
107     */ 
108    public int getRXCReps() {  
109        return getReps("RXC");
110    } 
111
112    /** 
113     * <p>
114     * Returns a non-modifiable List containing all current existing repetitions of RXC.
115     * <p>
116     * <p>
117     * Note that unlike {@link #getRXC()}, this method will not create any reps
118     * if none are already present, so an empty list may be returned.
119     * </p>
120     */ 
121    public java.util.List<RXC> getRXCAll() throws HL7Exception {
122        return getAllAsList("RXC", RXC.class);
123    } 
124
125    /**
126     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
127     * @see AbstractGroup#insertRepetition(Structure, int) 
128     */
129    public void insertRXC(RXC structure, int rep) throws HL7Exception { 
130       super.insertRepetition("RXC", structure, rep);
131    }
132
133
134    /**
135     * Inserts a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
136     * @see AbstractGroup#insertRepetition(Structure, int) 
137     */
138    public RXC insertRXC(int rep) throws HL7Exception { 
139       return (RXC)super.insertRepetition("RXC", rep);
140    }
141
142
143    /**
144     * Removes a specific repetition of RXC (RXC - pharmacy/treatment component order segment)
145     * @see AbstractGroup#removeRepetition(String, int) 
146     */
147    public RXC removeRXC(int rep) throws HL7Exception { 
148       return (RXC)super.removeRepetition("RXC", rep);
149    }
150
151
152
153    /**
154     * Returns
155     * the first repetition of 
156     * NTE (NTE - notes and comments segment) - creates it if necessary
157     */
158    public NTE getNTE() { 
159       NTE retVal = getTyped("NTE", NTE.class);
160       return retVal;
161    }
162
163
164    /**
165     * Returns a specific repetition of
166     * NTE (NTE - notes and comments segment) - creates it if necessary
167     *
168     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
169     * @throws HL7Exception if the repetition requested is more than one 
170     *     greater than the number of existing repetitions.
171     */
172    public NTE getNTE(int rep) { 
173       NTE retVal = getTyped("NTE", rep, NTE.class);
174       return retVal;
175    }
176
177    /** 
178     * Returns the number of existing repetitions of NTE 
179     */ 
180    public int getNTEReps() {  
181        return getReps("NTE");
182    } 
183
184    /** 
185     * <p>
186     * Returns a non-modifiable List containing all current existing repetitions of NTE.
187     * <p>
188     * <p>
189     * Note that unlike {@link #getNTE()}, this method will not create any reps
190     * if none are already present, so an empty list may be returned.
191     * </p>
192     */ 
193    public java.util.List<NTE> getNTEAll() throws HL7Exception {
194        return getAllAsList("NTE", NTE.class);
195    } 
196
197    /**
198     * Inserts a specific repetition of NTE (NTE - notes and comments segment)
199     * @see AbstractGroup#insertRepetition(Structure, int) 
200     */
201    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
202       super.insertRepetition("NTE", structure, rep);
203    }
204
205
206    /**
207     * Inserts a specific repetition of NTE (NTE - notes and comments segment)
208     * @see AbstractGroup#insertRepetition(Structure, int) 
209     */
210    public NTE insertNTE(int rep) throws HL7Exception { 
211       return (NTE)super.insertRepetition("NTE", rep);
212    }
213
214
215    /**
216     * Removes a specific repetition of NTE (NTE - notes and comments segment)
217     * @see AbstractGroup#removeRepetition(String, int) 
218     */
219    public NTE removeNTE(int rep) throws HL7Exception { 
220       return (NTE)super.removeRepetition("NTE", rep);
221    }
222
223
224
225}
226