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.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 OSM_R26_SHIPMENT 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: SHP (Shipment) <b>  </b></li>
049                         * <li>2: PRT (Participation Information) <b> repeating </b></li>
050                         * <li>3: OSM_R26_SHIPPING_OBSERVATION (a Group object) <b>optional repeating </b></li>
051                         * <li>4: OSM_R26_PACKAGE (a Group object) <b> repeating </b></li>
052 * </ul>
053 */
054//@SuppressWarnings("unused")
055public class OSM_R26_SHIPMENT extends AbstractGroup {
056
057    /** 
058     * Creates a new OSM_R26_SHIPMENT group
059     */
060    public OSM_R26_SHIPMENT(Group parent, ModelClassFactory factory) {
061       super(parent, factory);
062       init(factory);
063    }
064
065    private void init(ModelClassFactory factory) {
066       try {
067                                  this.add(SHP.class, true, false, false);
068                                  this.add(PRT.class, true, true, false);
069                                  this.add(OSM_R26_SHIPPING_OBSERVATION.class, false, true, false);
070                                  this.add(OSM_R26_PACKAGE.class, true, true, false);
071       } catch(HL7Exception e) {
072          log.error("Unexpected error creating OSM_R26_SHIPMENT - this is probably a bug in the source code generator.", e);
073       }
074    }
075
076    /** 
077     * Returns "2.7"
078     */
079    public String getVersion() {
080       return "2.7";
081    }
082
083
084
085    /**
086     * Returns
087     * SHP (Shipment) - creates it if necessary
088     */
089    public SHP getSHP() { 
090       SHP retVal = getTyped("SHP", SHP.class);
091       return retVal;
092    }
093
094
095
096
097    /**
098     * Returns
099     * the first repetition of 
100     * PRT (Participation Information) - creates it if necessary
101     */
102    public PRT getPRT() { 
103       PRT retVal = getTyped("PRT", PRT.class);
104       return retVal;
105    }
106
107
108    /**
109     * Returns a specific repetition of
110     * PRT (Participation Information) - 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 PRT getPRT(int rep) { 
117       PRT retVal = getTyped("PRT", rep, PRT.class);
118       return retVal;
119    }
120
121    /** 
122     * Returns the number of existing repetitions of PRT 
123     */ 
124    public int getPRTReps() {  
125        return getReps("PRT");
126    } 
127
128    /** 
129     * <p>
130     * Returns a non-modifiable List containing all current existing repetitions of PRT.
131     * <p>
132     * <p>
133     * Note that unlike {@link #getPRT()}, 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<PRT> getPRTAll() throws HL7Exception {
138        return getAllAsList("PRT", PRT.class);
139    } 
140
141    /**
142     * Inserts a specific repetition of PRT (Participation Information)
143     * @see AbstractGroup#insertRepetition(Structure, int) 
144     */
145    public void insertPRT(PRT structure, int rep) throws HL7Exception { 
146       super.insertRepetition("PRT", structure, rep);
147    }
148
149
150    /**
151     * Inserts a specific repetition of PRT (Participation Information)
152     * @see AbstractGroup#insertRepetition(Structure, int) 
153     */
154    public PRT insertPRT(int rep) throws HL7Exception { 
155       return (PRT)super.insertRepetition("PRT", rep);
156    }
157
158
159    /**
160     * Removes a specific repetition of PRT (Participation Information)
161     * @see AbstractGroup#removeRepetition(String, int) 
162     */
163    public PRT removePRT(int rep) throws HL7Exception { 
164       return (PRT)super.removeRepetition("PRT", rep);
165    }
166
167
168
169    /**
170     * Returns
171     * the first repetition of 
172     * SHIPPING_OBSERVATION (a Group object) - creates it if necessary
173     */
174    public OSM_R26_SHIPPING_OBSERVATION getSHIPPING_OBSERVATION() { 
175       OSM_R26_SHIPPING_OBSERVATION retVal = getTyped("SHIPPING_OBSERVATION", OSM_R26_SHIPPING_OBSERVATION.class);
176       return retVal;
177    }
178
179
180    /**
181     * Returns a specific repetition of
182     * SHIPPING_OBSERVATION (a Group object) - 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 OSM_R26_SHIPPING_OBSERVATION getSHIPPING_OBSERVATION(int rep) { 
189       OSM_R26_SHIPPING_OBSERVATION retVal = getTyped("SHIPPING_OBSERVATION", rep, OSM_R26_SHIPPING_OBSERVATION.class);
190       return retVal;
191    }
192
193    /** 
194     * Returns the number of existing repetitions of SHIPPING_OBSERVATION 
195     */ 
196    public int getSHIPPING_OBSERVATIONReps() {  
197        return getReps("SHIPPING_OBSERVATION");
198    } 
199
200    /** 
201     * <p>
202     * Returns a non-modifiable List containing all current existing repetitions of SHIPPING_OBSERVATION.
203     * <p>
204     * <p>
205     * Note that unlike {@link #getSHIPPING_OBSERVATION()}, 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<OSM_R26_SHIPPING_OBSERVATION> getSHIPPING_OBSERVATIONAll() throws HL7Exception {
210        return getAllAsList("SHIPPING_OBSERVATION", OSM_R26_SHIPPING_OBSERVATION.class);
211    } 
212
213    /**
214     * Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)
215     * @see AbstractGroup#insertRepetition(Structure, int) 
216     */
217    public void insertSHIPPING_OBSERVATION(OSM_R26_SHIPPING_OBSERVATION structure, int rep) throws HL7Exception { 
218       super.insertRepetition("SHIPPING_OBSERVATION", structure, rep);
219    }
220
221
222    /**
223     * Inserts a specific repetition of SHIPPING_OBSERVATION (a Group object)
224     * @see AbstractGroup#insertRepetition(Structure, int) 
225     */
226    public OSM_R26_SHIPPING_OBSERVATION insertSHIPPING_OBSERVATION(int rep) throws HL7Exception { 
227       return (OSM_R26_SHIPPING_OBSERVATION)super.insertRepetition("SHIPPING_OBSERVATION", rep);
228    }
229
230
231    /**
232     * Removes a specific repetition of SHIPPING_OBSERVATION (a Group object)
233     * @see AbstractGroup#removeRepetition(String, int) 
234     */
235    public OSM_R26_SHIPPING_OBSERVATION removeSHIPPING_OBSERVATION(int rep) throws HL7Exception { 
236       return (OSM_R26_SHIPPING_OBSERVATION)super.removeRepetition("SHIPPING_OBSERVATION", rep);
237    }
238
239
240
241    /**
242     * Returns
243     * the first repetition of 
244     * PACKAGE (a Group object) - creates it if necessary
245     */
246    public OSM_R26_PACKAGE getPACKAGE() { 
247       OSM_R26_PACKAGE retVal = getTyped("PACKAGE", OSM_R26_PACKAGE.class);
248       return retVal;
249    }
250
251
252    /**
253     * Returns a specific repetition of
254     * PACKAGE (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 OSM_R26_PACKAGE getPACKAGE(int rep) { 
261       OSM_R26_PACKAGE retVal = getTyped("PACKAGE", rep, OSM_R26_PACKAGE.class);
262       return retVal;
263    }
264
265    /** 
266     * Returns the number of existing repetitions of PACKAGE 
267     */ 
268    public int getPACKAGEReps() {  
269        return getReps("PACKAGE");
270    } 
271
272    /** 
273     * <p>
274     * Returns a non-modifiable List containing all current existing repetitions of PACKAGE.
275     * <p>
276     * <p>
277     * Note that unlike {@link #getPACKAGE()}, 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<OSM_R26_PACKAGE> getPACKAGEAll() throws HL7Exception {
282        return getAllAsList("PACKAGE", OSM_R26_PACKAGE.class);
283    } 
284
285    /**
286     * Inserts a specific repetition of PACKAGE (a Group object)
287     * @see AbstractGroup#insertRepetition(Structure, int) 
288     */
289    public void insertPACKAGE(OSM_R26_PACKAGE structure, int rep) throws HL7Exception { 
290       super.insertRepetition("PACKAGE", structure, rep);
291    }
292
293
294    /**
295     * Inserts a specific repetition of PACKAGE (a Group object)
296     * @see AbstractGroup#insertRepetition(Structure, int) 
297     */
298    public OSM_R26_PACKAGE insertPACKAGE(int rep) throws HL7Exception { 
299       return (OSM_R26_PACKAGE)super.insertRepetition("PACKAGE", rep);
300    }
301
302
303    /**
304     * Removes a specific repetition of PACKAGE (a Group object)
305     * @see AbstractGroup#removeRepetition(String, int) 
306     */
307    public OSM_R26_PACKAGE removePACKAGE(int rep) throws HL7Exception { 
308       return (OSM_R26_PACKAGE)super.removeRepetition("PACKAGE", rep);
309    }
310
311
312
313}
314