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.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 ROL message segment (Role). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>ROL-1: Role Instance ID (EI) <b> </b>
052     * <li>ROL-2: Action Code (ID) <b> </b>
053     * <li>ROL-3: Role-ROL (CE) <b> </b>
054     * <li>ROL-4: Role Person (XCN) <b> repeating</b>
055     * <li>ROL-5: Role Begin Date/Time (TS) <b>optional </b>
056     * <li>ROL-6: Role End Date/Time (TS) <b>optional </b>
057     * <li>ROL-7: Role Duration (CE) <b>optional </b>
058     * <li>ROL-8: Role Action Reason (CE) <b>optional </b>
059 * </ul>
060 */
061@SuppressWarnings("unused")
062public class ROL extends AbstractSegment {
063
064    /** 
065     * Creates a new ROL segment
066     */
067    public ROL(Group parent, ModelClassFactory factory) {
068       super(parent, factory);
069       init(factory);
070    }
071
072    private void init(ModelClassFactory factory) {
073       try {
074                                  this.add(EI.class, true, 1, 60, new Object[]{ getMessage() }, "Role Instance ID");
075                                              this.add(ID.class, true, 1, 2, new Object[]{ getMessage(), new Integer(287) }, "Action Code");
076                                  this.add(CE.class, true, 1, 80, new Object[]{ getMessage() }, "Role-ROL");
077                                  this.add(XCN.class, true, 0, 80, new Object[]{ getMessage() }, "Role Person");
078                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Role Begin Date/Time");
079                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Role End Date/Time");
080                                  this.add(CE.class, false, 1, 80, new Object[]{ getMessage() }, "Role Duration");
081                                  this.add(CE.class, false, 1, 80, new Object[]{ getMessage() }, "Role Action Reason");
082       } catch(HL7Exception e) {
083          log.error("Unexpected error creating ROL - this is probably a bug in the source code generator.", e);
084       }
085    }
086
087
088
089    /**
090     * Returns
091     * ROL-1: "Role Instance ID" - creates it if necessary
092     */
093    public EI getRoleInstanceID() { 
094                EI retVal = this.getTypedField(1, 0);
095                return retVal;
096    }
097    
098    /**
099     * Returns
100     * ROL-1: "Role Instance ID" - creates it if necessary
101     */
102    public EI getRol1_RoleInstanceID() { 
103                EI retVal = this.getTypedField(1, 0);
104                return retVal;
105    }
106
107
108
109    /**
110     * Returns
111     * ROL-2: "Action Code" - creates it if necessary
112     */
113    public ID getActionCode() { 
114                ID retVal = this.getTypedField(2, 0);
115                return retVal;
116    }
117    
118    /**
119     * Returns
120     * ROL-2: "Action Code" - creates it if necessary
121     */
122    public ID getRol2_ActionCode() { 
123                ID retVal = this.getTypedField(2, 0);
124                return retVal;
125    }
126
127
128
129    /**
130     * Returns
131     * ROL-3: "Role-ROL" - creates it if necessary
132     */
133    public CE getRoleROL() { 
134                CE retVal = this.getTypedField(3, 0);
135                return retVal;
136    }
137    
138    /**
139     * Returns
140     * ROL-3: "Role-ROL" - creates it if necessary
141     */
142    public CE getRol3_RoleROL() { 
143                CE retVal = this.getTypedField(3, 0);
144                return retVal;
145    }
146
147
148    /**
149     * Returns all repetitions of Role Person (ROL-4).
150     */
151    public XCN[] getRolePerson() {
152        XCN[] retVal = this.getTypedField(4, new XCN[0]);
153        return retVal;
154    }
155
156
157    /**
158     * Returns all repetitions of Role Person (ROL-4).
159     */
160    public XCN[] getRol4_RolePerson() {
161        XCN[] retVal = this.getTypedField(4, new XCN[0]);
162        return retVal;
163    }
164
165
166    /**
167     * Returns a count of the current number of repetitions of Role Person (ROL-4).
168     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
169     * it will return zero.
170     */
171    public int getRolePersonReps() {
172        return this.getReps(4);
173    }
174
175
176    /**
177     * Returns a specific repetition of
178     * ROL-4: "Role Person" - creates it if necessary
179     *
180     * @param rep The repetition index (0-indexed)
181     */
182    public XCN getRolePerson(int rep) { 
183                XCN retVal = this.getTypedField(4, rep);
184                return retVal;
185    }
186
187    /**
188     * Returns a specific repetition of
189     * ROL-4: "Role Person" - creates it if necessary
190     *
191     * @param rep The repetition index (0-indexed)
192     */
193    public XCN getRol4_RolePerson(int rep) { 
194                XCN retVal = this.getTypedField(4, rep);
195                return retVal;
196    }
197
198    /**
199     * Returns a count of the current number of repetitions of Role Person (ROL-4).
200     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
201     * it will return zero.
202     */
203    public int getRol4_RolePersonReps() {
204        return this.getReps(4);
205    }
206
207
208    /**
209     * Inserts a repetition of
210     * ROL-4: "Role Person" at a specific index
211     *
212     * @param rep The repetition index (0-indexed)
213     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
214     */
215    public XCN insertRolePerson(int rep) throws HL7Exception { 
216        return (XCN) super.insertRepetition(4, rep);
217    }
218
219
220    /**
221     * Inserts a repetition of
222     * ROL-4: "Role Person" at a specific index
223     *
224     * @param rep The repetition index (0-indexed)
225     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
226     */
227    public XCN insertRol4_RolePerson(int rep) throws HL7Exception { 
228        return (XCN) super.insertRepetition(4, rep);
229    }
230
231
232    /**
233     * Removes a repetition of
234     * ROL-4: "Role Person" at a specific index
235     *
236     * @param rep The repetition index (0-indexed)
237     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
238     */
239    public XCN removeRolePerson(int rep) throws HL7Exception { 
240        return (XCN) super.removeRepetition(4, rep);
241    }
242
243
244    /**
245     * Removes a repetition of
246     * ROL-4: "Role Person" at a specific index
247     *
248     * @param rep The repetition index (0-indexed)
249     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
250     */
251    public XCN removeRol4_RolePerson(int rep) throws HL7Exception { 
252        return (XCN) super.removeRepetition(4, rep);
253    }
254
255
256
257
258    /**
259     * Returns
260     * ROL-5: "Role Begin Date/Time" - creates it if necessary
261     */
262    public TS getRoleBeginDateTime() { 
263                TS retVal = this.getTypedField(5, 0);
264                return retVal;
265    }
266    
267    /**
268     * Returns
269     * ROL-5: "Role Begin Date/Time" - creates it if necessary
270     */
271    public TS getRol5_RoleBeginDateTime() { 
272                TS retVal = this.getTypedField(5, 0);
273                return retVal;
274    }
275
276
277
278    /**
279     * Returns
280     * ROL-6: "Role End Date/Time" - creates it if necessary
281     */
282    public TS getRoleEndDateTime() { 
283                TS retVal = this.getTypedField(6, 0);
284                return retVal;
285    }
286    
287    /**
288     * Returns
289     * ROL-6: "Role End Date/Time" - creates it if necessary
290     */
291    public TS getRol6_RoleEndDateTime() { 
292                TS retVal = this.getTypedField(6, 0);
293                return retVal;
294    }
295
296
297
298    /**
299     * Returns
300     * ROL-7: "Role Duration" - creates it if necessary
301     */
302    public CE getRoleDuration() { 
303                CE retVal = this.getTypedField(7, 0);
304                return retVal;
305    }
306    
307    /**
308     * Returns
309     * ROL-7: "Role Duration" - creates it if necessary
310     */
311    public CE getRol7_RoleDuration() { 
312                CE retVal = this.getTypedField(7, 0);
313                return retVal;
314    }
315
316
317
318    /**
319     * Returns
320     * ROL-8: "Role Action Reason" - creates it if necessary
321     */
322    public CE getRoleActionReason() { 
323                CE retVal = this.getTypedField(8, 0);
324                return retVal;
325    }
326    
327    /**
328     * Returns
329     * ROL-8: "Role Action Reason" - creates it if necessary
330     */
331    public CE getRol8_RoleActionReason() { 
332                CE retVal = this.getTypedField(8, 0);
333                return retVal;
334    }
335
336
337
338
339
340    /** {@inheritDoc} */   
341    protected Type createNewTypeWithoutReflection(int field) {
342       switch (field) {
343          case 0: return new EI(getMessage());
344          case 1: return new ID(getMessage(), new Integer( 287 ));
345          case 2: return new CE(getMessage());
346          case 3: return new XCN(getMessage());
347          case 4: return new TS(getMessage());
348          case 5: return new TS(getMessage());
349          case 6: return new CE(getMessage());
350          case 7: return new CE(getMessage());
351          default: return null;
352       }
353   }
354
355
356}
357