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.v23.segment;
035
036// import ca.uhn.hl7v2.model.v23.group.*;
037import ca.uhn.hl7v2.model.v23.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 AIP message segment (Appointment Information - Personnel Resource). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>AIP-1: Set ID - AIP (SI) <b> </b>
052     * <li>AIP-2: Segment Action Code (ID) <b>optional </b>
053     * <li>AIP-3: Personnel Resource ID (XCN) <b>optional </b>
054     * <li>AIP-4: Resource Role (CE) <b> </b>
055     * <li>AIP-5: Resource Group (CE) <b>optional repeating</b>
056     * <li>AIP-6: Start Date/Time (TS) <b>optional </b>
057     * <li>AIP-7: Start Date/Time Offset (NM) <b>optional </b>
058     * <li>AIP-8: Start Date/Time Offset Units (CE) <b>optional </b>
059     * <li>AIP-9: Duration (NM) <b>optional </b>
060     * <li>AIP-10: Duration Units (CE) <b>optional </b>
061     * <li>AIP-11: Allow Substitution Code (IS) <b>optional </b>
062     * <li>AIP-12: Filler Status Code (CE) <b>optional </b>
063 * </ul>
064 */
065@SuppressWarnings("unused")
066public class AIP extends AbstractSegment {
067
068    /** 
069     * Creates a new AIP segment
070     */
071    public AIP(Group parent, ModelClassFactory factory) {
072       super(parent, factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                                  this.add(SI.class, true, 1, 4, new Object[]{ getMessage() }, "Set ID - AIP");
079                                              this.add(ID.class, false, 1, 3, new Object[]{ getMessage(), new Integer(206) }, "Segment Action Code");
080                                  this.add(XCN.class, false, 1, 80, new Object[]{ getMessage() }, "Personnel Resource ID");
081                                  this.add(CE.class, true, 1, 60, new Object[]{ getMessage() }, "Resource Role");
082                                  this.add(CE.class, false, 0, 200, new Object[]{ getMessage() }, "Resource Group");
083                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Start Date/Time");
084                                  this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Start Date/Time Offset");
085                                  this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Start Date/Time Offset Units");
086                                  this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Duration");
087                                  this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Duration Units");
088                                              this.add(IS.class, false, 1, 10, new Object[]{ getMessage(), new Integer(279) }, "Allow Substitution Code");
089                                  this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Filler Status Code");
090       } catch(HL7Exception e) {
091          log.error("Unexpected error creating AIP - this is probably a bug in the source code generator.", e);
092       }
093    }
094
095
096
097    /**
098     * Returns
099     * AIP-1: "Set ID - AIP" - creates it if necessary
100     */
101    public SI getSetIDAIP() { 
102                SI retVal = this.getTypedField(1, 0);
103                return retVal;
104    }
105    
106    /**
107     * Returns
108     * AIP-1: "Set ID - AIP" - creates it if necessary
109     */
110    public SI getAip1_SetIDAIP() { 
111                SI retVal = this.getTypedField(1, 0);
112                return retVal;
113    }
114
115
116
117    /**
118     * Returns
119     * AIP-2: "Segment Action Code" - creates it if necessary
120     */
121    public ID getSegmentActionCode() { 
122                ID retVal = this.getTypedField(2, 0);
123                return retVal;
124    }
125    
126    /**
127     * Returns
128     * AIP-2: "Segment Action Code" - creates it if necessary
129     */
130    public ID getAip2_SegmentActionCode() { 
131                ID retVal = this.getTypedField(2, 0);
132                return retVal;
133    }
134
135
136
137    /**
138     * Returns
139     * AIP-3: "Personnel Resource ID" - creates it if necessary
140     */
141    public XCN getPersonnelResourceID() { 
142                XCN retVal = this.getTypedField(3, 0);
143                return retVal;
144    }
145    
146    /**
147     * Returns
148     * AIP-3: "Personnel Resource ID" - creates it if necessary
149     */
150    public XCN getAip3_PersonnelResourceID() { 
151                XCN retVal = this.getTypedField(3, 0);
152                return retVal;
153    }
154
155
156
157    /**
158     * Returns
159     * AIP-4: "Resource Role" - creates it if necessary
160     */
161    public CE getResourceRole() { 
162                CE retVal = this.getTypedField(4, 0);
163                return retVal;
164    }
165    
166    /**
167     * Returns
168     * AIP-4: "Resource Role" - creates it if necessary
169     */
170    public CE getAip4_ResourceRole() { 
171                CE retVal = this.getTypedField(4, 0);
172                return retVal;
173    }
174
175
176    /**
177     * Returns all repetitions of Resource Group (AIP-5).
178     */
179    public CE[] getResourceGroup() {
180        CE[] retVal = this.getTypedField(5, new CE[0]);
181        return retVal;
182    }
183
184
185    /**
186     * Returns all repetitions of Resource Group (AIP-5).
187     */
188    public CE[] getAip5_ResourceGroup() {
189        CE[] retVal = this.getTypedField(5, new CE[0]);
190        return retVal;
191    }
192
193
194    /**
195     * Returns a count of the current number of repetitions of Resource Group (AIP-5).
196     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
197     * it will return zero.
198     */
199    public int getResourceGroupReps() {
200        return this.getReps(5);
201    }
202
203
204    /**
205     * Returns a specific repetition of
206     * AIP-5: "Resource Group" - creates it if necessary
207     *
208     * @param rep The repetition index (0-indexed)
209     */
210    public CE getResourceGroup(int rep) { 
211                CE retVal = this.getTypedField(5, rep);
212                return retVal;
213    }
214
215    /**
216     * Returns a specific repetition of
217     * AIP-5: "Resource Group" - creates it if necessary
218     *
219     * @param rep The repetition index (0-indexed)
220     */
221    public CE getAip5_ResourceGroup(int rep) { 
222                CE retVal = this.getTypedField(5, rep);
223                return retVal;
224    }
225
226    /**
227     * Returns a count of the current number of repetitions of Resource Group (AIP-5).
228     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
229     * it will return zero.
230     */
231    public int getAip5_ResourceGroupReps() {
232        return this.getReps(5);
233    }
234
235
236    /**
237     * Inserts a repetition of
238     * AIP-5: "Resource Group" 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 CE insertResourceGroup(int rep) throws HL7Exception { 
244        return (CE) super.insertRepetition(5, rep);
245    }
246
247
248    /**
249     * Inserts a repetition of
250     * AIP-5: "Resource Group" 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 CE insertAip5_ResourceGroup(int rep) throws HL7Exception { 
256        return (CE) super.insertRepetition(5, rep);
257    }
258
259
260    /**
261     * Removes a repetition of
262     * AIP-5: "Resource Group" 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 CE removeResourceGroup(int rep) throws HL7Exception { 
268        return (CE) super.removeRepetition(5, rep);
269    }
270
271
272    /**
273     * Removes a repetition of
274     * AIP-5: "Resource Group" at a specific index
275     *
276     * @param rep The repetition index (0-indexed)
277     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
278     */
279    public CE removeAip5_ResourceGroup(int rep) throws HL7Exception { 
280        return (CE) super.removeRepetition(5, rep);
281    }
282
283
284
285
286    /**
287     * Returns
288     * AIP-6: "Start Date/Time" - creates it if necessary
289     */
290    public TS getStartDateTime() { 
291                TS retVal = this.getTypedField(6, 0);
292                return retVal;
293    }
294    
295    /**
296     * Returns
297     * AIP-6: "Start Date/Time" - creates it if necessary
298     */
299    public TS getAip6_StartDateTime() { 
300                TS retVal = this.getTypedField(6, 0);
301                return retVal;
302    }
303
304
305
306    /**
307     * Returns
308     * AIP-7: "Start Date/Time Offset" - creates it if necessary
309     */
310    public NM getStartDateTimeOffset() { 
311                NM retVal = this.getTypedField(7, 0);
312                return retVal;
313    }
314    
315    /**
316     * Returns
317     * AIP-7: "Start Date/Time Offset" - creates it if necessary
318     */
319    public NM getAip7_StartDateTimeOffset() { 
320                NM retVal = this.getTypedField(7, 0);
321                return retVal;
322    }
323
324
325
326    /**
327     * Returns
328     * AIP-8: "Start Date/Time Offset Units" - creates it if necessary
329     */
330    public CE getStartDateTimeOffsetUnits() { 
331                CE retVal = this.getTypedField(8, 0);
332                return retVal;
333    }
334    
335    /**
336     * Returns
337     * AIP-8: "Start Date/Time Offset Units" - creates it if necessary
338     */
339    public CE getAip8_StartDateTimeOffsetUnits() { 
340                CE retVal = this.getTypedField(8, 0);
341                return retVal;
342    }
343
344
345
346    /**
347     * Returns
348     * AIP-9: "Duration" - creates it if necessary
349     */
350    public NM getDuration() { 
351                NM retVal = this.getTypedField(9, 0);
352                return retVal;
353    }
354    
355    /**
356     * Returns
357     * AIP-9: "Duration" - creates it if necessary
358     */
359    public NM getAip9_Duration() { 
360                NM retVal = this.getTypedField(9, 0);
361                return retVal;
362    }
363
364
365
366    /**
367     * Returns
368     * AIP-10: "Duration Units" - creates it if necessary
369     */
370    public CE getDurationUnits() { 
371                CE retVal = this.getTypedField(10, 0);
372                return retVal;
373    }
374    
375    /**
376     * Returns
377     * AIP-10: "Duration Units" - creates it if necessary
378     */
379    public CE getAip10_DurationUnits() { 
380                CE retVal = this.getTypedField(10, 0);
381                return retVal;
382    }
383
384
385
386    /**
387     * Returns
388     * AIP-11: "Allow Substitution Code" - creates it if necessary
389     */
390    public IS getAllowSubstitutionCode() { 
391                IS retVal = this.getTypedField(11, 0);
392                return retVal;
393    }
394    
395    /**
396     * Returns
397     * AIP-11: "Allow Substitution Code" - creates it if necessary
398     */
399    public IS getAip11_AllowSubstitutionCode() { 
400                IS retVal = this.getTypedField(11, 0);
401                return retVal;
402    }
403
404
405
406    /**
407     * Returns
408     * AIP-12: "Filler Status Code" - creates it if necessary
409     */
410    public CE getFillerStatusCode() { 
411                CE retVal = this.getTypedField(12, 0);
412                return retVal;
413    }
414    
415    /**
416     * Returns
417     * AIP-12: "Filler Status Code" - creates it if necessary
418     */
419    public CE getAip12_FillerStatusCode() { 
420                CE retVal = this.getTypedField(12, 0);
421                return retVal;
422    }
423
424
425
426
427
428    /** {@inheritDoc} */   
429    protected Type createNewTypeWithoutReflection(int field) {
430       switch (field) {
431          case 0: return new SI(getMessage());
432          case 1: return new ID(getMessage(), new Integer( 206 ));
433          case 2: return new XCN(getMessage());
434          case 3: return new CE(getMessage());
435          case 4: return new CE(getMessage());
436          case 5: return new TS(getMessage());
437          case 6: return new NM(getMessage());
438          case 7: return new CE(getMessage());
439          case 8: return new NM(getMessage());
440          case 9: return new CE(getMessage());
441          case 10: return new IS(getMessage(), new Integer( 279 ));
442          case 11: return new CE(getMessage());
443          default: return null;
444       }
445   }
446
447
448}
449