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