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