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.v25.group;
035
036import ca.uhn.hl7v2.model.v25.segment.*;
037
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.model.*;
041
042/**
043 * <p>Represents a PPV_PCA_PROBLEM 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: PRB (Problem Details) <b>  </b></li>
049                         * <li>2: NTE (Notes and Comments) <b>optional repeating </b></li>
050                         * <li>3: VAR (Variance) <b>optional repeating </b></li>
051                         * <li>4: PPV_PCA_PROBLEM_ROLE (a Group object) <b>optional repeating </b></li>
052                         * <li>5: PPV_PCA_PROBLEM_OBSERVATION (a Group object) <b>optional repeating </b></li>
053 * </ul>
054 */
055//@SuppressWarnings("unused")
056public class PPV_PCA_PROBLEM extends AbstractGroup {
057
058    /** 
059     * Creates a new PPV_PCA_PROBLEM group
060     */
061    public PPV_PCA_PROBLEM(Group parent, ModelClassFactory factory) {
062       super(parent, factory);
063       init(factory);
064    }
065
066    private void init(ModelClassFactory factory) {
067       try {
068                                  this.add(PRB.class, true, false, false);
069                                  this.add(NTE.class, false, true, false);
070                                  this.add(VAR.class, false, true, false);
071                                  this.add(PPV_PCA_PROBLEM_ROLE.class, false, true, false);
072                                  this.add(PPV_PCA_PROBLEM_OBSERVATION.class, false, true, false);
073       } catch(HL7Exception e) {
074          log.error("Unexpected error creating PPV_PCA_PROBLEM - this is probably a bug in the source code generator.", e);
075       }
076    }
077
078    /** 
079     * Returns "2.5"
080     */
081    public String getVersion() {
082       return "2.5";
083    }
084
085
086
087    /**
088     * Returns
089     * PRB (Problem Details) - creates it if necessary
090     */
091    public PRB getPRB() { 
092       PRB retVal = getTyped("PRB", PRB.class);
093       return retVal;
094    }
095
096
097
098
099    /**
100     * Returns
101     * the first repetition of 
102     * NTE (Notes and Comments) - creates it if necessary
103     */
104    public NTE getNTE() { 
105       NTE retVal = getTyped("NTE", NTE.class);
106       return retVal;
107    }
108
109
110    /**
111     * Returns a specific repetition of
112     * NTE (Notes and Comments) - creates it if necessary
113     *
114     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
115     * @throws HL7Exception if the repetition requested is more than one 
116     *     greater than the number of existing repetitions.
117     */
118    public NTE getNTE(int rep) { 
119       NTE retVal = getTyped("NTE", rep, NTE.class);
120       return retVal;
121    }
122
123    /** 
124     * Returns the number of existing repetitions of NTE 
125     */ 
126    public int getNTEReps() {  
127        return getReps("NTE");
128    } 
129
130    /** 
131     * <p>
132     * Returns a non-modifiable List containing all current existing repetitions of NTE.
133     * <p>
134     * <p>
135     * Note that unlike {@link #getNTE()}, this method will not create any reps
136     * if none are already present, so an empty list may be returned.
137     * </p>
138     */ 
139    public java.util.List<NTE> getNTEAll() throws HL7Exception {
140        return getAllAsList("NTE", NTE.class);
141    } 
142
143    /**
144     * Inserts a specific repetition of NTE (Notes and Comments)
145     * @see AbstractGroup#insertRepetition(Structure, int) 
146     */
147    public void insertNTE(NTE structure, int rep) throws HL7Exception { 
148       super.insertRepetition("NTE", structure, rep);
149    }
150
151
152    /**
153     * Inserts a specific repetition of NTE (Notes and Comments)
154     * @see AbstractGroup#insertRepetition(Structure, int) 
155     */
156    public NTE insertNTE(int rep) throws HL7Exception { 
157       return (NTE)super.insertRepetition("NTE", rep);
158    }
159
160
161    /**
162     * Removes a specific repetition of NTE (Notes and Comments)
163     * @see AbstractGroup#removeRepetition(String, int) 
164     */
165    public NTE removeNTE(int rep) throws HL7Exception { 
166       return (NTE)super.removeRepetition("NTE", rep);
167    }
168
169
170
171    /**
172     * Returns
173     * the first repetition of 
174     * VAR (Variance) - creates it if necessary
175     */
176    public VAR getVAR() { 
177       VAR retVal = getTyped("VAR", VAR.class);
178       return retVal;
179    }
180
181
182    /**
183     * Returns a specific repetition of
184     * VAR (Variance) - creates it if necessary
185     *
186     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
187     * @throws HL7Exception if the repetition requested is more than one 
188     *     greater than the number of existing repetitions.
189     */
190    public VAR getVAR(int rep) { 
191       VAR retVal = getTyped("VAR", rep, VAR.class);
192       return retVal;
193    }
194
195    /** 
196     * Returns the number of existing repetitions of VAR 
197     */ 
198    public int getVARReps() {  
199        return getReps("VAR");
200    } 
201
202    /** 
203     * <p>
204     * Returns a non-modifiable List containing all current existing repetitions of VAR.
205     * <p>
206     * <p>
207     * Note that unlike {@link #getVAR()}, this method will not create any reps
208     * if none are already present, so an empty list may be returned.
209     * </p>
210     */ 
211    public java.util.List<VAR> getVARAll() throws HL7Exception {
212        return getAllAsList("VAR", VAR.class);
213    } 
214
215    /**
216     * Inserts a specific repetition of VAR (Variance)
217     * @see AbstractGroup#insertRepetition(Structure, int) 
218     */
219    public void insertVAR(VAR structure, int rep) throws HL7Exception { 
220       super.insertRepetition("VAR", structure, rep);
221    }
222
223
224    /**
225     * Inserts a specific repetition of VAR (Variance)
226     * @see AbstractGroup#insertRepetition(Structure, int) 
227     */
228    public VAR insertVAR(int rep) throws HL7Exception { 
229       return (VAR)super.insertRepetition("VAR", rep);
230    }
231
232
233    /**
234     * Removes a specific repetition of VAR (Variance)
235     * @see AbstractGroup#removeRepetition(String, int) 
236     */
237    public VAR removeVAR(int rep) throws HL7Exception { 
238       return (VAR)super.removeRepetition("VAR", rep);
239    }
240
241
242
243    /**
244     * Returns
245     * the first repetition of 
246     * PROBLEM_ROLE (a Group object) - creates it if necessary
247     */
248    public PPV_PCA_PROBLEM_ROLE getPROBLEM_ROLE() { 
249       PPV_PCA_PROBLEM_ROLE retVal = getTyped("PROBLEM_ROLE", PPV_PCA_PROBLEM_ROLE.class);
250       return retVal;
251    }
252
253
254    /**
255     * Returns a specific repetition of
256     * PROBLEM_ROLE (a Group object) - creates it if necessary
257     *
258     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
259     * @throws HL7Exception if the repetition requested is more than one 
260     *     greater than the number of existing repetitions.
261     */
262    public PPV_PCA_PROBLEM_ROLE getPROBLEM_ROLE(int rep) { 
263       PPV_PCA_PROBLEM_ROLE retVal = getTyped("PROBLEM_ROLE", rep, PPV_PCA_PROBLEM_ROLE.class);
264       return retVal;
265    }
266
267    /** 
268     * Returns the number of existing repetitions of PROBLEM_ROLE 
269     */ 
270    public int getPROBLEM_ROLEReps() {  
271        return getReps("PROBLEM_ROLE");
272    } 
273
274    /** 
275     * <p>
276     * Returns a non-modifiable List containing all current existing repetitions of PROBLEM_ROLE.
277     * <p>
278     * <p>
279     * Note that unlike {@link #getPROBLEM_ROLE()}, this method will not create any reps
280     * if none are already present, so an empty list may be returned.
281     * </p>
282     */ 
283    public java.util.List<PPV_PCA_PROBLEM_ROLE> getPROBLEM_ROLEAll() throws HL7Exception {
284        return getAllAsList("PROBLEM_ROLE", PPV_PCA_PROBLEM_ROLE.class);
285    } 
286
287    /**
288     * Inserts a specific repetition of PROBLEM_ROLE (a Group object)
289     * @see AbstractGroup#insertRepetition(Structure, int) 
290     */
291    public void insertPROBLEM_ROLE(PPV_PCA_PROBLEM_ROLE structure, int rep) throws HL7Exception { 
292       super.insertRepetition("PROBLEM_ROLE", structure, rep);
293    }
294
295
296    /**
297     * Inserts a specific repetition of PROBLEM_ROLE (a Group object)
298     * @see AbstractGroup#insertRepetition(Structure, int) 
299     */
300    public PPV_PCA_PROBLEM_ROLE insertPROBLEM_ROLE(int rep) throws HL7Exception { 
301       return (PPV_PCA_PROBLEM_ROLE)super.insertRepetition("PROBLEM_ROLE", rep);
302    }
303
304
305    /**
306     * Removes a specific repetition of PROBLEM_ROLE (a Group object)
307     * @see AbstractGroup#removeRepetition(String, int) 
308     */
309    public PPV_PCA_PROBLEM_ROLE removePROBLEM_ROLE(int rep) throws HL7Exception { 
310       return (PPV_PCA_PROBLEM_ROLE)super.removeRepetition("PROBLEM_ROLE", rep);
311    }
312
313
314
315    /**
316     * Returns
317     * the first repetition of 
318     * PROBLEM_OBSERVATION (a Group object) - creates it if necessary
319     */
320    public PPV_PCA_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION() { 
321       PPV_PCA_PROBLEM_OBSERVATION retVal = getTyped("PROBLEM_OBSERVATION", PPV_PCA_PROBLEM_OBSERVATION.class);
322       return retVal;
323    }
324
325
326    /**
327     * Returns a specific repetition of
328     * PROBLEM_OBSERVATION (a Group object) - creates it if necessary
329     *
330     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
331     * @throws HL7Exception if the repetition requested is more than one 
332     *     greater than the number of existing repetitions.
333     */
334    public PPV_PCA_PROBLEM_OBSERVATION getPROBLEM_OBSERVATION(int rep) { 
335       PPV_PCA_PROBLEM_OBSERVATION retVal = getTyped("PROBLEM_OBSERVATION", rep, PPV_PCA_PROBLEM_OBSERVATION.class);
336       return retVal;
337    }
338
339    /** 
340     * Returns the number of existing repetitions of PROBLEM_OBSERVATION 
341     */ 
342    public int getPROBLEM_OBSERVATIONReps() {  
343        return getReps("PROBLEM_OBSERVATION");
344    } 
345
346    /** 
347     * <p>
348     * Returns a non-modifiable List containing all current existing repetitions of PROBLEM_OBSERVATION.
349     * <p>
350     * <p>
351     * Note that unlike {@link #getPROBLEM_OBSERVATION()}, this method will not create any reps
352     * if none are already present, so an empty list may be returned.
353     * </p>
354     */ 
355    public java.util.List<PPV_PCA_PROBLEM_OBSERVATION> getPROBLEM_OBSERVATIONAll() throws HL7Exception {
356        return getAllAsList("PROBLEM_OBSERVATION", PPV_PCA_PROBLEM_OBSERVATION.class);
357    } 
358
359    /**
360     * Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
361     * @see AbstractGroup#insertRepetition(Structure, int) 
362     */
363    public void insertPROBLEM_OBSERVATION(PPV_PCA_PROBLEM_OBSERVATION structure, int rep) throws HL7Exception { 
364       super.insertRepetition("PROBLEM_OBSERVATION", structure, rep);
365    }
366
367
368    /**
369     * Inserts a specific repetition of PROBLEM_OBSERVATION (a Group object)
370     * @see AbstractGroup#insertRepetition(Structure, int) 
371     */
372    public PPV_PCA_PROBLEM_OBSERVATION insertPROBLEM_OBSERVATION(int rep) throws HL7Exception { 
373       return (PPV_PCA_PROBLEM_OBSERVATION)super.insertRepetition("PROBLEM_OBSERVATION", rep);
374    }
375
376
377    /**
378     * Removes a specific repetition of PROBLEM_OBSERVATION (a Group object)
379     * @see AbstractGroup#removeRepetition(String, int) 
380     */
381    public PPV_PCA_PROBLEM_OBSERVATION removePROBLEM_OBSERVATION(int rep) throws HL7Exception { 
382       return (PPV_PCA_PROBLEM_OBSERVATION)super.removeRepetition("PROBLEM_OBSERVATION", rep);
383    }
384
385
386
387}
388