View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v27.group;
35  
36  import ca.uhn.hl7v2.model.v27.segment.*;
37  
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.model.*;
41  
42  /**
43   * <p>Represents a VXU_V04_ORDER group structure (a Group object).
44   * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
45   * This Group contains the following elements:  
46   * </p>
47   * <ul>
48                           * <li>1: ORC (Common Order) <b>  </b></li>
49                           * <li>2: VXU_V04_TIMING (a Group object) <b>optional repeating </b></li>
50                           * <li>3: RXA (Pharmacy/Treatment Administration) <b>  </b></li>
51                           * <li>4: RXR (Pharmacy/Treatment Route) <b>optional  </b></li>
52                           * <li>5: VXU_V04_OBSERVATION (a Group object) <b>optional repeating </b></li>
53   * </ul>
54   */
55  //@SuppressWarnings("unused")
56  public class VXU_V04_ORDER extends AbstractGroup {
57  
58      /** 
59       * Creates a new VXU_V04_ORDER group
60       */
61      public VXU_V04_ORDER(Group parent, ModelClassFactory factory) {
62         super(parent, factory);
63         init(factory);
64      }
65  
66      private void init(ModelClassFactory factory) {
67         try {
68                                    this.add(ORC.class, true, false, false);
69                                    this.add(VXU_V04_TIMING.class, false, true, false);
70                                    this.add(RXA.class, true, false, false);
71                                    this.add(RXR.class, false, false, false);
72                                    this.add(VXU_V04_OBSERVATION.class, false, true, false);
73         } catch(HL7Exception e) {
74            log.error("Unexpected error creating VXU_V04_ORDER - this is probably a bug in the source code generator.", e);
75         }
76      }
77  
78      /** 
79       * Returns "2.7"
80       */
81      public String getVersion() {
82         return "2.7";
83      }
84  
85  
86  
87      /**
88       * Returns
89       * ORC (Common Order) - creates it if necessary
90       */
91      public ORC getORC() { 
92         ORC retVal = getTyped("ORC", ORC.class);
93         return retVal;
94      }
95  
96  
97  
98  
99      /**
100      * Returns
101      * the first repetition of 
102      * TIMING (a Group object) - creates it if necessary
103      */
104     public VXU_V04_TIMING getTIMING() { 
105        VXU_V04_TIMING retVal = getTyped("TIMING", VXU_V04_TIMING.class);
106        return retVal;
107     }
108 
109 
110     /**
111      * Returns a specific repetition of
112      * TIMING (a Group object) - 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 VXU_V04_TIMING getTIMING(int rep) { 
119        VXU_V04_TIMING retVal = getTyped("TIMING", rep, VXU_V04_TIMING.class);
120        return retVal;
121     }
122 
123     /** 
124      * Returns the number of existing repetitions of TIMING 
125      */ 
126     public int getTIMINGReps() {  
127         return getReps("TIMING");
128     } 
129 
130     /** 
131      * <p>
132      * Returns a non-modifiable List containing all current existing repetitions of TIMING.
133      * <p>
134      * <p>
135      * Note that unlike {@link #getTIMING()}, 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<VXU_V04_TIMING> getTIMINGAll() throws HL7Exception {
140     	return getAllAsList("TIMING", VXU_V04_TIMING.class);
141     } 
142 
143     /**
144      * Inserts a specific repetition of TIMING (a Group object)
145      * @see AbstractGroup#insertRepetition(Structure, int) 
146      */
147     public void insertTIMING(VXU_V04_TIMING structure, int rep) throws HL7Exception { 
148        super.insertRepetition("TIMING", structure, rep);
149     }
150 
151 
152     /**
153      * Inserts a specific repetition of TIMING (a Group object)
154      * @see AbstractGroup#insertRepetition(Structure, int) 
155      */
156     public VXU_V04_TIMING insertTIMING(int rep) throws HL7Exception { 
157        return (VXU_V04_TIMING)super.insertRepetition("TIMING", rep);
158     }
159 
160 
161     /**
162      * Removes a specific repetition of TIMING (a Group object)
163      * @see AbstractGroup#removeRepetition(String, int) 
164      */
165     public VXU_V04_TIMING removeTIMING(int rep) throws HL7Exception { 
166        return (VXU_V04_TIMING)super.removeRepetition("TIMING", rep);
167     }
168 
169 
170 
171     /**
172      * Returns
173      * RXA (Pharmacy/Treatment Administration) - creates it if necessary
174      */
175     public RXA getRXA() { 
176        RXA retVal = getTyped("RXA", RXA.class);
177        return retVal;
178     }
179 
180 
181 
182 
183     /**
184      * Returns
185      * RXR (Pharmacy/Treatment Route) - creates it if necessary
186      */
187     public RXR getRXR() { 
188        RXR retVal = getTyped("RXR", RXR.class);
189        return retVal;
190     }
191 
192 
193 
194 
195     /**
196      * Returns
197      * the first repetition of 
198      * OBSERVATION (a Group object) - creates it if necessary
199      */
200     public VXU_V04_OBSERVATION getOBSERVATION() { 
201        VXU_V04_OBSERVATION retVal = getTyped("OBSERVATION", VXU_V04_OBSERVATION.class);
202        return retVal;
203     }
204 
205 
206     /**
207      * Returns a specific repetition of
208      * OBSERVATION (a Group object) - creates it if necessary
209      *
210      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
211      * @throws HL7Exception if the repetition requested is more than one 
212      *     greater than the number of existing repetitions.
213      */
214     public VXU_V04_OBSERVATION getOBSERVATION(int rep) { 
215        VXU_V04_OBSERVATION retVal = getTyped("OBSERVATION", rep, VXU_V04_OBSERVATION.class);
216        return retVal;
217     }
218 
219     /** 
220      * Returns the number of existing repetitions of OBSERVATION 
221      */ 
222     public int getOBSERVATIONReps() {  
223         return getReps("OBSERVATION");
224     } 
225 
226     /** 
227      * <p>
228      * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION.
229      * <p>
230      * <p>
231      * Note that unlike {@link #getOBSERVATION()}, this method will not create any reps
232      * if none are already present, so an empty list may be returned.
233      * </p>
234      */ 
235     public java.util.List<VXU_V04_OBSERVATION> getOBSERVATIONAll() throws HL7Exception {
236     	return getAllAsList("OBSERVATION", VXU_V04_OBSERVATION.class);
237     } 
238 
239     /**
240      * Inserts a specific repetition of OBSERVATION (a Group object)
241      * @see AbstractGroup#insertRepetition(Structure, int) 
242      */
243     public void insertOBSERVATION(VXU_V04_OBSERVATION structure, int rep) throws HL7Exception { 
244        super.insertRepetition("OBSERVATION", structure, rep);
245     }
246 
247 
248     /**
249      * Inserts a specific repetition of OBSERVATION (a Group object)
250      * @see AbstractGroup#insertRepetition(Structure, int) 
251      */
252     public VXU_V04_OBSERVATION insertOBSERVATION(int rep) throws HL7Exception { 
253        return (VXU_V04_OBSERVATION)super.insertRepetition("OBSERVATION", rep);
254     }
255 
256 
257     /**
258      * Removes a specific repetition of OBSERVATION (a Group object)
259      * @see AbstractGroup#removeRepetition(String, int) 
260      */
261     public VXU_V04_OBSERVATION removeOBSERVATION(int rep) throws HL7Exception { 
262        return (VXU_V04_OBSERVATION)super.removeRepetition("OBSERVATION", rep);
263     }
264 
265 
266 
267 }
268