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.v24.group;
035
036import ca.uhn.hl7v2.model.v24.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 OMG_O19_ORDER_PRIOR 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: ORC (Common Order) <b>optional </b></li>
051                 * <li>2: OBR (Observation Request) <b> </b></li>
052                 * <li>3: NTE (Notes and Comments) <b>optional repeating</b></li>
053                 * <li>4: CTD (Contact Data) <b>optional </b></li>
054                 * <li>5: OMG_O19_OBSERVATION_PRIOR (a Group object) <b> repeating</b></li>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class OMG_O19_ORDER_PRIOR extends AbstractGroup {
059
060    /** 
061     * Creates a new OMG_O19_ORDER_PRIOR group
062     */
063    public OMG_O19_ORDER_PRIOR(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                          this.add(ORC.class, false, false);
071                          this.add(OBR.class, true, false);
072                          this.add(NTE.class, false, true);
073                          this.add(CTD.class, false, false);
074                          this.add(OMG_O19_OBSERVATION_PRIOR.class, true, true);
075       } catch(HL7Exception e) {
076          log.error("Unexpected error creating OMG_O19_ORDER_PRIOR - this is probably a bug in the source code generator.", e);
077       }
078    }
079
080    /** 
081     * Returns "2.4"
082     */
083    public String getVersion() {
084       return "2.4";
085    }
086
087
088
089    /**
090     * Returns
091     * ORC (Common Order) - creates it if necessary
092     */
093    public ORC getORC() { 
094       ORC retVal = getTyped("ORC", ORC.class);
095       return retVal;
096    }
097
098
099
100
101    /**
102     * Returns
103     * OBR (Observation Request) - creates it if necessary
104     */
105    public OBR getOBR() { 
106       OBR retVal = getTyped("OBR", OBR.class);
107       return retVal;
108    }
109
110
111
112
113    /**
114     * Returns
115     * the first repetition of 
116     * NTE (Notes and Comments) - creates it if necessary
117     */
118    public NTE getNTE() { 
119       NTE retVal = getTyped("NTE", NTE.class);
120       return retVal;
121    }
122
123
124    /**
125     * Returns a specific repetition of
126     * NTE (Notes and Comments) - creates it if necessary
127     *
128     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
129     * @throws HL7Exception if the repetition requested is more than one 
130     *     greater than the number of existing repetitions.
131     */
132    public NTE getNTE(int rep) { 
133       NTE retVal = getTyped("NTE", rep, NTE.class);
134       return retVal;
135    }
136
137    /** 
138     * Returns the number of existing repetitions of NTE 
139     */ 
140    public int getNTEReps() {  
141        return getReps("NTE");
142    } 
143
144    /** 
145     * <p>
146     * Returns a non-modifiable List containing all current existing repetitions of NTE.
147     * <p>
148     * <p>
149     * Note that unlike {@link #getNTE()}, this method will not create any reps
150     * if none are already present, so an empty list may be returned.
151     * </p>
152     */ 
153    public List<NTE> getNTEAll() throws HL7Exception {
154        return getAllAsList("NTE", NTE.class);
155    } 
156
157    /**
158     * Inserts a specific repetition of NTE (Notes and Comments)
159     * @see AbstractGroup#insertRepetition(Structure, int) 
160     */
161    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
162       super.insertRepetition("NTE", structure, rep);
163    }
164
165
166    /**
167     * Inserts a specific repetition of NTE (Notes and Comments)
168     * @see AbstractGroup#insertRepetition(Structure, int) 
169     */
170    public NTE insertNTE(int rep) throws HL7Exception { 
171       return (NTE)super.insertRepetition("NTE", rep);
172    }
173
174
175    /**
176     * Removes a specific repetition of NTE (Notes and Comments)
177     * @see AbstractGroup#removeRepetition(String, int) 
178     */
179    public NTE removeNTE(int rep) throws HL7Exception { 
180       return (NTE)super.removeRepetition("NTE", rep);
181    }
182
183
184
185    /**
186     * Returns
187     * CTD (Contact Data) - creates it if necessary
188     */
189    public CTD getCTD() { 
190       CTD retVal = getTyped("CTD", CTD.class);
191       return retVal;
192    }
193
194
195
196
197    /**
198     * Returns
199     * the first repetition of 
200     * OBSERVATION_PRIOR (a Group object) - creates it if necessary
201     */
202    public OMG_O19_OBSERVATION_PRIOR getOBSERVATION_PRIOR() { 
203       OMG_O19_OBSERVATION_PRIOR retVal = getTyped("OBSERVATION_PRIOR", OMG_O19_OBSERVATION_PRIOR.class);
204       return retVal;
205    }
206
207
208    /**
209     * Returns a specific repetition of
210     * OBSERVATION_PRIOR (a Group object) - creates it if necessary
211     *
212     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
213     * @throws HL7Exception if the repetition requested is more than one 
214     *     greater than the number of existing repetitions.
215     */
216    public OMG_O19_OBSERVATION_PRIOR getOBSERVATION_PRIOR(int rep) { 
217       OMG_O19_OBSERVATION_PRIOR retVal = getTyped("OBSERVATION_PRIOR", rep, OMG_O19_OBSERVATION_PRIOR.class);
218       return retVal;
219    }
220
221    /** 
222     * Returns the number of existing repetitions of OBSERVATION_PRIOR 
223     */ 
224    public int getOBSERVATION_PRIORReps() {  
225        return getReps("OBSERVATION_PRIOR");
226    } 
227
228    /** 
229     * <p>
230     * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_PRIOR.
231     * <p>
232     * <p>
233     * Note that unlike {@link #getOBSERVATION_PRIOR()}, this method will not create any reps
234     * if none are already present, so an empty list may be returned.
235     * </p>
236     */ 
237    public List<OMG_O19_OBSERVATION_PRIOR> getOBSERVATION_PRIORAll() throws HL7Exception {
238        return getAllAsList("OBSERVATION_PRIOR", OMG_O19_OBSERVATION_PRIOR.class);
239    } 
240
241    /**
242     * Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
243     * @see AbstractGroup#insertRepetition(Structure, int) 
244     */
245    public void insertOBSERVATION_PRIOR(OMG_O19_OBSERVATION_PRIOR structure, int rep) throws HL7Exception { 
246       super.insertRepetition("OBSERVATION_PRIOR", structure, rep);
247    }
248
249
250    /**
251     * Inserts a specific repetition of OBSERVATION_PRIOR (a Group object)
252     * @see AbstractGroup#insertRepetition(Structure, int) 
253     */
254    public OMG_O19_OBSERVATION_PRIOR insertOBSERVATION_PRIOR(int rep) throws HL7Exception { 
255       return (OMG_O19_OBSERVATION_PRIOR)super.insertRepetition("OBSERVATION_PRIOR", rep);
256    }
257
258
259    /**
260     * Removes a specific repetition of OBSERVATION_PRIOR (a Group object)
261     * @see AbstractGroup#removeRepetition(String, int) 
262     */
263    public OMG_O19_OBSERVATION_PRIOR removeOBSERVATION_PRIOR(int rep) throws HL7Exception { 
264       return (OMG_O19_OBSERVATION_PRIOR)super.removeRepetition("OBSERVATION_PRIOR", rep);
265    }
266
267
268
269}
270