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.v231.segment;
035
036// import ca.uhn.hl7v2.model.v231.group.*;
037import ca.uhn.hl7v2.model.v231.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047/**
048 *<p>Represents an HL7 EVN message segment (EVN - event type segment). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>EVN-1: Event Type Code (ID) <b>optional </b>
052     * <li>EVN-2: Recorded Date/Time (TS) <b> </b>
053     * <li>EVN-3: Date/Time Planned Event (TS) <b>optional </b>
054     * <li>EVN-4: Event Reason Code (IS) <b>optional </b>
055     * <li>EVN-5: Operator ID (XCN) <b>optional repeating</b>
056     * <li>EVN-6: Event Occurred (TS) <b>optional </b>
057 * </ul>
058 */
059@SuppressWarnings("unused")
060public class EVN extends AbstractSegment {
061
062    /** 
063     * Creates a new EVN segment
064     */
065    public EVN(Group parent, ModelClassFactory factory) {
066       super(parent, factory);
067       init(factory);
068    }
069
070    private void init(ModelClassFactory factory) {
071       try {
072                                              this.add(ID.class, false, 1, 3, new Object[]{ getMessage(), new Integer(3) }, "Event Type Code");
073                                  this.add(TS.class, true, 1, 26, new Object[]{ getMessage() }, "Recorded Date/Time");
074                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Date/Time Planned Event");
075                                              this.add(IS.class, false, 1, 3, new Object[]{ getMessage(), new Integer(62) }, "Event Reason Code");
076                                  this.add(XCN.class, false, 0, 60, new Object[]{ getMessage() }, "Operator ID");
077                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Event Occurred");
078       } catch(HL7Exception e) {
079          log.error("Unexpected error creating EVN - this is probably a bug in the source code generator.", e);
080       }
081    }
082
083
084
085    /**
086     * Returns
087     * EVN-1: "Event Type Code" - creates it if necessary
088     */
089    public ID getEventTypeCode() { 
090                ID retVal = this.getTypedField(1, 0);
091                return retVal;
092    }
093    
094    /**
095     * Returns
096     * EVN-1: "Event Type Code" - creates it if necessary
097     */
098    public ID getEvn1_EventTypeCode() { 
099                ID retVal = this.getTypedField(1, 0);
100                return retVal;
101    }
102
103
104
105    /**
106     * Returns
107     * EVN-2: "Recorded Date/Time" - creates it if necessary
108     */
109    public TS getRecordedDateTime() { 
110                TS retVal = this.getTypedField(2, 0);
111                return retVal;
112    }
113    
114    /**
115     * Returns
116     * EVN-2: "Recorded Date/Time" - creates it if necessary
117     */
118    public TS getEvn2_RecordedDateTime() { 
119                TS retVal = this.getTypedField(2, 0);
120                return retVal;
121    }
122
123
124
125    /**
126     * Returns
127     * EVN-3: "Date/Time Planned Event" - creates it if necessary
128     */
129    public TS getDateTimePlannedEvent() { 
130                TS retVal = this.getTypedField(3, 0);
131                return retVal;
132    }
133    
134    /**
135     * Returns
136     * EVN-3: "Date/Time Planned Event" - creates it if necessary
137     */
138    public TS getEvn3_DateTimePlannedEvent() { 
139                TS retVal = this.getTypedField(3, 0);
140                return retVal;
141    }
142
143
144
145    /**
146     * Returns
147     * EVN-4: "Event Reason Code" - creates it if necessary
148     */
149    public IS getEventReasonCode() { 
150                IS retVal = this.getTypedField(4, 0);
151                return retVal;
152    }
153    
154    /**
155     * Returns
156     * EVN-4: "Event Reason Code" - creates it if necessary
157     */
158    public IS getEvn4_EventReasonCode() { 
159                IS retVal = this.getTypedField(4, 0);
160                return retVal;
161    }
162
163
164    /**
165     * Returns all repetitions of Operator ID (EVN-5).
166     */
167    public XCN[] getOperatorID() {
168        XCN[] retVal = this.getTypedField(5, new XCN[0]);
169        return retVal;
170    }
171
172
173    /**
174     * Returns all repetitions of Operator ID (EVN-5).
175     */
176    public XCN[] getEvn5_OperatorID() {
177        XCN[] retVal = this.getTypedField(5, new XCN[0]);
178        return retVal;
179    }
180
181
182    /**
183     * Returns a count of the current number of repetitions of Operator ID (EVN-5).
184     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
185     * it will return zero.
186     */
187    public int getOperatorIDReps() {
188        return this.getReps(5);
189    }
190
191
192    /**
193     * Returns a specific repetition of
194     * EVN-5: "Operator ID" - creates it if necessary
195     *
196     * @param rep The repetition index (0-indexed)
197     */
198    public XCN getOperatorID(int rep) { 
199                XCN retVal = this.getTypedField(5, rep);
200                return retVal;
201    }
202
203    /**
204     * Returns a specific repetition of
205     * EVN-5: "Operator ID" - creates it if necessary
206     *
207     * @param rep The repetition index (0-indexed)
208     */
209    public XCN getEvn5_OperatorID(int rep) { 
210                XCN retVal = this.getTypedField(5, rep);
211                return retVal;
212    }
213
214    /**
215     * Returns a count of the current number of repetitions of Operator ID (EVN-5).
216     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
217     * it will return zero.
218     */
219    public int getEvn5_OperatorIDReps() {
220        return this.getReps(5);
221    }
222
223
224    /**
225     * Inserts a repetition of
226     * EVN-5: "Operator ID" at a specific index
227     *
228     * @param rep The repetition index (0-indexed)
229     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
230     */
231    public XCN insertOperatorID(int rep) throws HL7Exception { 
232        return (XCN) super.insertRepetition(5, rep);
233    }
234
235
236    /**
237     * Inserts a repetition of
238     * EVN-5: "Operator ID" at a specific index
239     *
240     * @param rep The repetition index (0-indexed)
241     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
242     */
243    public XCN insertEvn5_OperatorID(int rep) throws HL7Exception { 
244        return (XCN) super.insertRepetition(5, rep);
245    }
246
247
248    /**
249     * Removes a repetition of
250     * EVN-5: "Operator ID" at a specific index
251     *
252     * @param rep The repetition index (0-indexed)
253     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
254     */
255    public XCN removeOperatorID(int rep) throws HL7Exception { 
256        return (XCN) super.removeRepetition(5, rep);
257    }
258
259
260    /**
261     * Removes a repetition of
262     * EVN-5: "Operator ID" at a specific index
263     *
264     * @param rep The repetition index (0-indexed)
265     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
266     */
267    public XCN removeEvn5_OperatorID(int rep) throws HL7Exception { 
268        return (XCN) super.removeRepetition(5, rep);
269    }
270
271
272
273
274    /**
275     * Returns
276     * EVN-6: "Event Occurred" - creates it if necessary
277     */
278    public TS getEventOccurred() { 
279                TS retVal = this.getTypedField(6, 0);
280                return retVal;
281    }
282    
283    /**
284     * Returns
285     * EVN-6: "Event Occurred" - creates it if necessary
286     */
287    public TS getEvn6_EventOccurred() { 
288                TS retVal = this.getTypedField(6, 0);
289                return retVal;
290    }
291
292
293
294
295
296    /** {@inheritDoc} */   
297    protected Type createNewTypeWithoutReflection(int field) {
298       switch (field) {
299          case 0: return new ID(getMessage(), new Integer( 3 ));
300          case 1: return new TS(getMessage());
301          case 2: return new TS(getMessage());
302          case 3: return new IS(getMessage(), new Integer( 62 ));
303          case 4: return new XCN(getMessage());
304          case 5: return new TS(getMessage());
305          default: return null;
306       }
307   }
308
309
310}
311