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
008 package ca.uhn.hl7v2.model.v24.group;
009
010 import ca.uhn.hl7v2.model.v24.segment.*;
011
012 import ca.uhn.log.HapiLogFactory;
013 import ca.uhn.hl7v2.HL7Exception;
014 import ca.uhn.hl7v2.parser.ModelClassFactory;
015 import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
016 import ca.uhn.hl7v2.model.AbstractMessage;
017 import ca.uhn.hl7v2.model.Group;
018 import ca.uhn.hl7v2.model.AbstractGroup;
019 import ca.uhn.hl7v2.model.GenericSegment;
020
021 /**
022 * <p>Represents a ORD_O04_ORDER_DIET group structure (a Group object).
023 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
024 * This Group contains the following elements:
025 * </p>
026 * <ul>
027 * <li>1: ORC (Common Order) <b> </b></li>
028 * <li>2: ODS (Dietary Orders, Supplements, and Preferences) <b>optional repeating</b></li>
029 * <li>3: NTE (Notes and Comments) <b>optional repeating</b></li>
030 * </ul>
031 */
032 public class ORD_O04_ORDER_DIET extends AbstractGroup {
033
034 /**
035 * Creates a new ORD_O04_ORDER_DIET group
036 */
037 public ORD_O04_ORDER_DIET(Group parent, ModelClassFactory factory) {
038 super(parent, factory);
039 init(factory);
040 }
041
042 private void init(ModelClassFactory factory) {
043 try {
044 this.add(ORC.class, true, false);
045 this.add(ODS.class, false, true);
046 this.add(NTE.class, false, true);
047 } catch(HL7Exception e) {
048 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error creating ORD_O04_ORDER_DIET - this is probably a bug in the source code generator.", e);
049 }
050 }
051
052 /**
053 * Returns "2.4"
054 */
055 public String getVersion() {
056 return "2.4";
057 }
058
059
060
061 /**
062 * Returns
063 * ORC (Common Order) - creates it if necessary
064 */
065 public ORC getORC() {
066 ORC ret = null;
067 try {
068 ret = (ORC)this.get("ORC");
069 } catch(HL7Exception e) {
070 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
071 throw new RuntimeException(e);
072 }
073 return ret;
074 }
075
076
077
078
079 /**
080 * Returns
081 * the first repetition of
082 * ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
083 */
084 public ODS getODS() {
085 ODS ret = null;
086 try {
087 ret = (ODS)this.get("ODS");
088 } catch(HL7Exception e) {
089 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
090 throw new RuntimeException(e);
091 }
092 return ret;
093 }
094
095
096 /**
097 * Returns a specific repetition of
098 * ODS (Dietary Orders, Supplements, and Preferences) - creates it if necessary
099 *
100 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
101 * @throws HL7Exception if the repetition requested is more than one
102 * greater than the number of existing repetitions.
103 */
104 public ODS getODS(int rep) {
105 ODS ret = null;
106 try {
107 ret = (ODS)this.get("ODS", rep);
108 } catch(HL7Exception e) {
109 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
110 throw new RuntimeException(e);
111 }
112 return ret;
113 }
114
115 /**
116 * Returns the number of existing repetitions of ODS
117 */
118 public int getODSReps() {
119 int reps = -1;
120 try {
121 reps = this.getAll("ODS").length;
122 } catch (HL7Exception e) {
123 String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
124 HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
125 throw new RuntimeException(message);
126 }
127 return reps;
128 }
129
130 /**
131 * Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
132 * @see AbstractGroup#insertRepetition(Structure, int)
133 */
134 public void insertODS(ODS structure, int rep) throws HL7Exception {
135 super.insertRepetition("ODS", structure, rep);
136 }
137
138
139 /**
140 * Inserts a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
141 * @see AbstractGroup#insertRepetition(Structure, int)
142 */
143 public ODS insertODS(int rep) throws HL7Exception {
144 return (ODS)super.insertRepetition("ODS", rep);
145 }
146
147
148 /**
149 * Removes a specific repetition of ODS (Dietary Orders, Supplements, and Preferences)
150 * @see AbstractGroup#removeRepetition(String, int)
151 */
152 public ODS removeODS(int rep) throws HL7Exception {
153 return (ODS)super.removeRepetition("ODS", rep);
154 }
155
156
157
158 /**
159 * Returns
160 * the first repetition of
161 * NTE (Notes and Comments) - creates it if necessary
162 */
163 public NTE getNTE() {
164 NTE ret = null;
165 try {
166 ret = (NTE)this.get("NTE");
167 } catch(HL7Exception e) {
168 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
169 throw new RuntimeException(e);
170 }
171 return ret;
172 }
173
174
175 /**
176 * Returns a specific repetition of
177 * NTE (Notes and Comments) - creates it if necessary
178 *
179 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
180 * @throws HL7Exception if the repetition requested is more than one
181 * greater than the number of existing repetitions.
182 */
183 public NTE getNTE(int rep) {
184 NTE ret = null;
185 try {
186 ret = (NTE)this.get("NTE", rep);
187 } catch(HL7Exception e) {
188 HapiLogFactory.getHapiLog(this.getClass()).error("Unexpected error accessing data - this is probably a bug in the source code generator.", e);
189 throw new RuntimeException(e);
190 }
191 return ret;
192 }
193
194 /**
195 * Returns the number of existing repetitions of NTE
196 */
197 public int getNTEReps() {
198 int reps = -1;
199 try {
200 reps = this.getAll("NTE").length;
201 } catch (HL7Exception e) {
202 String message = "Unexpected error accessing data - this is probably a bug in the source code generator.";
203 HapiLogFactory.getHapiLog(this.getClass()).error(message, e);
204 throw new RuntimeException(message);
205 }
206 return reps;
207 }
208
209 /**
210 * Inserts a specific repetition of NTE (Notes and Comments)
211 * @see AbstractGroup#insertRepetition(Structure, int)
212 */
213 public void insertNTE(NTE structure, int rep) throws HL7Exception {
214 super.insertRepetition("NTE", structure, rep);
215 }
216
217
218 /**
219 * Inserts a specific repetition of NTE (Notes and Comments)
220 * @see AbstractGroup#insertRepetition(Structure, int)
221 */
222 public NTE insertNTE(int rep) throws HL7Exception {
223 return (NTE)super.insertRepetition("NTE", rep);
224 }
225
226
227 /**
228 * Removes a specific repetition of NTE (Notes and Comments)
229 * @see AbstractGroup#removeRepetition(String, int)
230 */
231 public NTE removeNTE(int rep) throws HL7Exception {
232 return (NTE)super.removeRepetition("NTE", rep);
233 }
234
235
236
237 }
238