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.v281.group;
035
036import ca.uhn.hl7v2.model.v281.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a ORL_O43_SPECIMEN 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: SPM (Specimen) <b>  </b></li>
049                         * <li>2: ORL_O43_SPECIMEN_OBSERVATION (a Group object) <b>optional repeating </b></li>
050                         * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li>
051                         * <li>4: ORL_O43_SPECIMEN_CONTAINER (a Group object) <b> repeating </b></li>
052 * </ul>
053 */
054//@SuppressWarnings("unused")
055public class ORL_O43_SPECIMEN extends AbstractGroup {
056
057    /** 
058     * Creates a new ORL_O43_SPECIMEN group
059     */
060    public ORL_O43_SPECIMEN(Group parent, ModelClassFactory factory) {
061       super(parent, factory);
062       init(factory);
063    }
064
065    private void init(ModelClassFactory factory) {
066       try {
067                                  this.add(SPM.class, true, false, false);
068                                  this.add(ORL_O43_SPECIMEN_OBSERVATION.class, false, true, false);
069                                  this.add(NTE.class, false, true, false);
070                                  this.add(ORL_O43_SPECIMEN_CONTAINER.class, true, true, false);
071       } catch(HL7Exception e) {
072          log.error("Unexpected error creating ORL_O43_SPECIMEN - this is probably a bug in the source code generator.", e);
073       }
074    }
075
076    /** 
077     * Returns "2.8.1"
078     */
079    public String getVersion() {
080       return "2.8.1";
081    }
082
083
084
085    /**
086     * Returns
087     * SPM (Specimen) - creates it if necessary
088     */
089    public SPM getSPM() { 
090       SPM retVal = getTyped("SPM", SPM.class);
091       return retVal;
092    }
093
094
095
096
097    /**
098     * Returns
099     * the first repetition of 
100     * SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
101     */
102    public ORL_O43_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION() { 
103       ORL_O43_SPECIMEN_OBSERVATION retVal = getTyped("SPECIMEN_OBSERVATION", ORL_O43_SPECIMEN_OBSERVATION.class);
104       return retVal;
105    }
106
107
108    /**
109     * Returns a specific repetition of
110     * SPECIMEN_OBSERVATION (a Group object) - creates it if necessary
111     *
112     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
113     * @throws HL7Exception if the repetition requested is more than one 
114     *     greater than the number of existing repetitions.
115     */
116    public ORL_O43_SPECIMEN_OBSERVATION getSPECIMEN_OBSERVATION(int rep) { 
117       ORL_O43_SPECIMEN_OBSERVATION retVal = getTyped("SPECIMEN_OBSERVATION", rep, ORL_O43_SPECIMEN_OBSERVATION.class);
118       return retVal;
119    }
120
121    /** 
122     * Returns the number of existing repetitions of SPECIMEN_OBSERVATION 
123     */ 
124    public int getSPECIMEN_OBSERVATIONReps() {  
125        return getReps("SPECIMEN_OBSERVATION");
126    } 
127
128    /** 
129     * <p>
130     * Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_OBSERVATION.
131     * <p>
132     * <p>
133     * Note that unlike {@link #getSPECIMEN_OBSERVATION()}, this method will not create any reps
134     * if none are already present, so an empty list may be returned.
135     * </p>
136     */ 
137    public java.util.List<ORL_O43_SPECIMEN_OBSERVATION> getSPECIMEN_OBSERVATIONAll() throws HL7Exception {
138        return getAllAsList("SPECIMEN_OBSERVATION", ORL_O43_SPECIMEN_OBSERVATION.class);
139    } 
140
141    /**
142     * Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
143     * @see AbstractGroup#insertRepetition(Structure, int) 
144     */
145    public void insertSPECIMEN_OBSERVATION(ORL_O43_SPECIMEN_OBSERVATION structure, int rep) throws HL7Exception { 
146       super.insertRepetition("SPECIMEN_OBSERVATION", structure, rep);
147    }
148
149
150    /**
151     * Inserts a specific repetition of SPECIMEN_OBSERVATION (a Group object)
152     * @see AbstractGroup#insertRepetition(Structure, int) 
153     */
154    public ORL_O43_SPECIMEN_OBSERVATION insertSPECIMEN_OBSERVATION(int rep) throws HL7Exception { 
155       return (ORL_O43_SPECIMEN_OBSERVATION)super.insertRepetition("SPECIMEN_OBSERVATION", rep);
156    }
157
158
159    /**
160     * Removes a specific repetition of SPECIMEN_OBSERVATION (a Group object)
161     * @see AbstractGroup#removeRepetition(String, int) 
162     */
163    public ORL_O43_SPECIMEN_OBSERVATION removeSPECIMEN_OBSERVATION(int rep) throws HL7Exception { 
164       return (ORL_O43_SPECIMEN_OBSERVATION)super.removeRepetition("SPECIMEN_OBSERVATION", rep);
165    }
166
167
168
169    /**
170     * Returns
171     * the first repetition of 
172     * NTE (Notes and Comments) - creates it if necessary
173     */
174    public NTE getNTE() { 
175       NTE retVal = getTyped("NTE", NTE.class);
176       return retVal;
177    }
178
179
180    /**
181     * Returns a specific repetition of
182     * NTE (Notes and Comments) - creates it if necessary
183     *
184     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
185     * @throws HL7Exception if the repetition requested is more than one 
186     *     greater than the number of existing repetitions.
187     */
188    public NTE getNTE(int rep) { 
189       NTE retVal = getTyped("NTE", rep, NTE.class);
190       return retVal;
191    }
192
193    /** 
194     * Returns the number of existing repetitions of NTE 
195     */ 
196    public int getNTEReps() {  
197        return getReps("NTE");
198    } 
199
200    /** 
201     * <p>
202     * Returns a non-modifiable List containing all current existing repetitions of NTE.
203     * <p>
204     * <p>
205     * Note that unlike {@link #getNTE()}, this method will not create any reps
206     * if none are already present, so an empty list may be returned.
207     * </p>
208     */ 
209    public java.util.List<NTE> getNTEAll() throws HL7Exception {
210        return getAllAsList("NTE", NTE.class);
211    } 
212
213    /**
214     * Inserts a specific repetition of NTE (Notes and Comments)
215     * @see AbstractGroup#insertRepetition(Structure, int) 
216     */
217    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
218       super.insertRepetition("NTE", structure, rep);
219    }
220
221
222    /**
223     * Inserts a specific repetition of NTE (Notes and Comments)
224     * @see AbstractGroup#insertRepetition(Structure, int) 
225     */
226    public NTE insertNTE(int rep) throws HL7Exception { 
227       return (NTE)super.insertRepetition("NTE", rep);
228    }
229
230
231    /**
232     * Removes a specific repetition of NTE (Notes and Comments)
233     * @see AbstractGroup#removeRepetition(String, int) 
234     */
235    public NTE removeNTE(int rep) throws HL7Exception { 
236       return (NTE)super.removeRepetition("NTE", rep);
237    }
238
239
240
241    /**
242     * Returns
243     * the first repetition of 
244     * SPECIMEN_CONTAINER (a Group object) - creates it if necessary
245     */
246    public ORL_O43_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER() { 
247       ORL_O43_SPECIMEN_CONTAINER retVal = getTyped("SPECIMEN_CONTAINER", ORL_O43_SPECIMEN_CONTAINER.class);
248       return retVal;
249    }
250
251
252    /**
253     * Returns a specific repetition of
254     * SPECIMEN_CONTAINER (a Group object) - creates it if necessary
255     *
256     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
257     * @throws HL7Exception if the repetition requested is more than one 
258     *     greater than the number of existing repetitions.
259     */
260    public ORL_O43_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER(int rep) { 
261       ORL_O43_SPECIMEN_CONTAINER retVal = getTyped("SPECIMEN_CONTAINER", rep, ORL_O43_SPECIMEN_CONTAINER.class);
262       return retVal;
263    }
264
265    /** 
266     * Returns the number of existing repetitions of SPECIMEN_CONTAINER 
267     */ 
268    public int getSPECIMEN_CONTAINERReps() {  
269        return getReps("SPECIMEN_CONTAINER");
270    } 
271
272    /** 
273     * <p>
274     * Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_CONTAINER.
275     * <p>
276     * <p>
277     * Note that unlike {@link #getSPECIMEN_CONTAINER()}, this method will not create any reps
278     * if none are already present, so an empty list may be returned.
279     * </p>
280     */ 
281    public java.util.List<ORL_O43_SPECIMEN_CONTAINER> getSPECIMEN_CONTAINERAll() throws HL7Exception {
282        return getAllAsList("SPECIMEN_CONTAINER", ORL_O43_SPECIMEN_CONTAINER.class);
283    } 
284
285    /**
286     * Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
287     * @see AbstractGroup#insertRepetition(Structure, int) 
288     */
289    public void insertSPECIMEN_CONTAINER(ORL_O43_SPECIMEN_CONTAINER structure, int rep) throws HL7Exception { 
290       super.insertRepetition("SPECIMEN_CONTAINER", structure, rep);
291    }
292
293
294    /**
295     * Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object)
296     * @see AbstractGroup#insertRepetition(Structure, int) 
297     */
298    public ORL_O43_SPECIMEN_CONTAINER insertSPECIMEN_CONTAINER(int rep) throws HL7Exception { 
299       return (ORL_O43_SPECIMEN_CONTAINER)super.insertRepetition("SPECIMEN_CONTAINER", rep);
300    }
301
302
303    /**
304     * Removes a specific repetition of SPECIMEN_CONTAINER (a Group object)
305     * @see AbstractGroup#removeRepetition(String, int) 
306     */
307    public ORL_O43_SPECIMEN_CONTAINER removeSPECIMEN_CONTAINER(int rep) throws HL7Exception { 
308       return (ORL_O43_SPECIMEN_CONTAINER)super.removeRepetition("SPECIMEN_CONTAINER", rep);
309    }
310
311
312
313}
314