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.v28.group;
35
36 import ca.uhn.hl7v2.model.v28.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 OUL_R24_ORDER_DOCUMENT 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: OBX (Observation/Result) <b> </b></li>
49 * <li>2: PRT (Participation Information) <b>optional repeating </b></li>
50 * <li>3: TXA (Transcription Document Header) <b> </b></li>
51 * </ul>
52 */
53 //@SuppressWarnings("unused")
54 public class OUL_R24_ORDER_DOCUMENT extends AbstractGroup {
55
56 /**
57 * Creates a new OUL_R24_ORDER_DOCUMENT group
58 */
59 public OUL_R24_ORDER_DOCUMENT(Group parent, ModelClassFactory factory) {
60 super(parent, factory);
61 init(factory);
62 }
63
64 private void init(ModelClassFactory factory) {
65 try {
66 this.add(OBX.class, true, false, false);
67 this.add(PRT.class, false, true, false);
68 this.add(TXA.class, true, false, false);
69 } catch(HL7Exception e) {
70 log.error("Unexpected error creating OUL_R24_ORDER_DOCUMENT - this is probably a bug in the source code generator.", e);
71 }
72 }
73
74 /**
75 * Returns "2.8"
76 */
77 public String getVersion() {
78 return "2.8";
79 }
80
81
82
83 /**
84 * Returns
85 * OBX (Observation/Result) - creates it if necessary
86 */
87 public OBX getOBX() {
88 OBX retVal = getTyped("OBX", OBX.class);
89 return retVal;
90 }
91
92
93
94
95 /**
96 * Returns
97 * the first repetition of
98 * PRT (Participation Information) - creates it if necessary
99 */
100 public PRT getPRT() {
101 PRT retVal = getTyped("PRT", PRT.class);
102 return retVal;
103 }
104
105
106 /**
107 * Returns a specific repetition of
108 * PRT (Participation Information) - creates it if necessary
109 *
110 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
111 * @throws HL7Exception if the repetition requested is more than one
112 * greater than the number of existing repetitions.
113 */
114 public PRT getPRT(int rep) {
115 PRT retVal = getTyped("PRT", rep, PRT.class);
116 return retVal;
117 }
118
119 /**
120 * Returns the number of existing repetitions of PRT
121 */
122 public int getPRTReps() {
123 return getReps("PRT");
124 }
125
126 /**
127 * <p>
128 * Returns a non-modifiable List containing all current existing repetitions of PRT.
129 * <p>
130 * <p>
131 * Note that unlike {@link #getPRT()}, this method will not create any reps
132 * if none are already present, so an empty list may be returned.
133 * </p>
134 */
135 public java.util.List<PRT> getPRTAll() throws HL7Exception {
136 return getAllAsList("PRT", PRT.class);
137 }
138
139 /**
140 * Inserts a specific repetition of PRT (Participation Information)
141 * @see AbstractGroup#insertRepetition(Structure, int)
142 */
143 public void insertPRT(PRT structure, int rep) throws HL7Exception {
144 super.insertRepetition("PRT", structure, rep);
145 }
146
147
148 /**
149 * Inserts a specific repetition of PRT (Participation Information)
150 * @see AbstractGroup#insertRepetition(Structure, int)
151 */
152 public PRT insertPRT(int rep) throws HL7Exception {
153 return (PRT)super.insertRepetition("PRT", rep);
154 }
155
156
157 /**
158 * Removes a specific repetition of PRT (Participation Information)
159 * @see AbstractGroup#removeRepetition(String, int)
160 */
161 public PRT removePRT(int rep) throws HL7Exception {
162 return (PRT)super.removeRepetition("PRT", rep);
163 }
164
165
166
167 /**
168 * Returns
169 * TXA (Transcription Document Header) - creates it if necessary
170 */
171 public TXA getTXA() {
172 TXA retVal = getTyped("TXA", TXA.class);
173 return retVal;
174 }
175
176
177
178
179 }
180