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 AIS message segment (AIS - appointment information - service segment). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>AIS-1: Set ID - AIS (SI) <b> </b>
052     * <li>AIS-2: Segment Action Code (ID) <b>optional </b>
053     * <li>AIS-3: Universal Service ID (CE) <b> </b>
054     * <li>AIS-4: Start Date/Time (TS) <b>optional </b>
055     * <li>AIS-5: Start Date/Time Offset (NM) <b>optional </b>
056     * <li>AIS-6: Start Date/Time Offset Units (CE) <b>optional </b>
057     * <li>AIS-7: Duration (NM) <b>optional </b>
058     * <li>AIS-8: Duration Units (CE) <b>optional </b>
059     * <li>AIS-9: Allow Substitution Code (IS) <b>optional </b>
060     * <li>AIS-10: Filler Status Code (CE) <b>optional </b>
061 * </ul>
062 */
063@SuppressWarnings("unused")
064public class AIS extends AbstractSegment {
065
066    /** 
067     * Creates a new AIS segment
068     */
069    public AIS(Group parent, ModelClassFactory factory) {
070       super(parent, factory);
071       init(factory);
072    }
073
074    private void init(ModelClassFactory factory) {
075       try {
076                                  this.add(SI.class, true, 1, 4, new Object[]{ getMessage() }, "Set ID - AIS");
077                                              this.add(ID.class, false, 1, 3, new Object[]{ getMessage(), new Integer(206) }, "Segment Action Code");
078                                  this.add(CE.class, true, 1, 200, new Object[]{ getMessage() }, "Universal Service ID");
079                                  this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Start Date/Time");
080                                  this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Start Date/Time Offset");
081                                  this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Start Date/Time Offset Units");
082                                  this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Duration");
083                                  this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Duration Units");
084                                              this.add(IS.class, false, 1, 10, new Object[]{ getMessage(), new Integer(279) }, "Allow Substitution Code");
085                                  this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Filler Status Code");
086       } catch(HL7Exception e) {
087          log.error("Unexpected error creating AIS - this is probably a bug in the source code generator.", e);
088       }
089    }
090
091
092
093    /**
094     * Returns
095     * AIS-1: "Set ID - AIS" - creates it if necessary
096     */
097    public SI getSetIDAIS() { 
098                SI retVal = this.getTypedField(1, 0);
099                return retVal;
100    }
101    
102    /**
103     * Returns
104     * AIS-1: "Set ID - AIS" - creates it if necessary
105     */
106    public SI getAis1_SetIDAIS() { 
107                SI retVal = this.getTypedField(1, 0);
108                return retVal;
109    }
110
111
112
113    /**
114     * Returns
115     * AIS-2: "Segment Action Code" - creates it if necessary
116     */
117    public ID getSegmentActionCode() { 
118                ID retVal = this.getTypedField(2, 0);
119                return retVal;
120    }
121    
122    /**
123     * Returns
124     * AIS-2: "Segment Action Code" - creates it if necessary
125     */
126    public ID getAis2_SegmentActionCode() { 
127                ID retVal = this.getTypedField(2, 0);
128                return retVal;
129    }
130
131
132
133    /**
134     * Returns
135     * AIS-3: "Universal Service ID" - creates it if necessary
136     */
137    public CE getUniversalServiceID() { 
138                CE retVal = this.getTypedField(3, 0);
139                return retVal;
140    }
141    
142    /**
143     * Returns
144     * AIS-3: "Universal Service ID" - creates it if necessary
145     */
146    public CE getAis3_UniversalServiceID() { 
147                CE retVal = this.getTypedField(3, 0);
148                return retVal;
149    }
150
151
152
153    /**
154     * Returns
155     * AIS-4: "Start Date/Time" - creates it if necessary
156     */
157    public TS getStartDateTime() { 
158                TS retVal = this.getTypedField(4, 0);
159                return retVal;
160    }
161    
162    /**
163     * Returns
164     * AIS-4: "Start Date/Time" - creates it if necessary
165     */
166    public TS getAis4_StartDateTime() { 
167                TS retVal = this.getTypedField(4, 0);
168                return retVal;
169    }
170
171
172
173    /**
174     * Returns
175     * AIS-5: "Start Date/Time Offset" - creates it if necessary
176     */
177    public NM getStartDateTimeOffset() { 
178                NM retVal = this.getTypedField(5, 0);
179                return retVal;
180    }
181    
182    /**
183     * Returns
184     * AIS-5: "Start Date/Time Offset" - creates it if necessary
185     */
186    public NM getAis5_StartDateTimeOffset() { 
187                NM retVal = this.getTypedField(5, 0);
188                return retVal;
189    }
190
191
192
193    /**
194     * Returns
195     * AIS-6: "Start Date/Time Offset Units" - creates it if necessary
196     */
197    public CE getStartDateTimeOffsetUnits() { 
198                CE retVal = this.getTypedField(6, 0);
199                return retVal;
200    }
201    
202    /**
203     * Returns
204     * AIS-6: "Start Date/Time Offset Units" - creates it if necessary
205     */
206    public CE getAis6_StartDateTimeOffsetUnits() { 
207                CE retVal = this.getTypedField(6, 0);
208                return retVal;
209    }
210
211
212
213    /**
214     * Returns
215     * AIS-7: "Duration" - creates it if necessary
216     */
217    public NM getDuration() { 
218                NM retVal = this.getTypedField(7, 0);
219                return retVal;
220    }
221    
222    /**
223     * Returns
224     * AIS-7: "Duration" - creates it if necessary
225     */
226    public NM getAis7_Duration() { 
227                NM retVal = this.getTypedField(7, 0);
228                return retVal;
229    }
230
231
232
233    /**
234     * Returns
235     * AIS-8: "Duration Units" - creates it if necessary
236     */
237    public CE getDurationUnits() { 
238                CE retVal = this.getTypedField(8, 0);
239                return retVal;
240    }
241    
242    /**
243     * Returns
244     * AIS-8: "Duration Units" - creates it if necessary
245     */
246    public CE getAis8_DurationUnits() { 
247                CE retVal = this.getTypedField(8, 0);
248                return retVal;
249    }
250
251
252
253    /**
254     * Returns
255     * AIS-9: "Allow Substitution Code" - creates it if necessary
256     */
257    public IS getAllowSubstitutionCode() { 
258                IS retVal = this.getTypedField(9, 0);
259                return retVal;
260    }
261    
262    /**
263     * Returns
264     * AIS-9: "Allow Substitution Code" - creates it if necessary
265     */
266    public IS getAis9_AllowSubstitutionCode() { 
267                IS retVal = this.getTypedField(9, 0);
268                return retVal;
269    }
270
271
272
273    /**
274     * Returns
275     * AIS-10: "Filler Status Code" - creates it if necessary
276     */
277    public CE getFillerStatusCode() { 
278                CE retVal = this.getTypedField(10, 0);
279                return retVal;
280    }
281    
282    /**
283     * Returns
284     * AIS-10: "Filler Status Code" - creates it if necessary
285     */
286    public CE getAis10_FillerStatusCode() { 
287                CE retVal = this.getTypedField(10, 0);
288                return retVal;
289    }
290
291
292
293
294
295    /** {@inheritDoc} */   
296    protected Type createNewTypeWithoutReflection(int field) {
297       switch (field) {
298          case 0: return new SI(getMessage());
299          case 1: return new ID(getMessage(), new Integer( 206 ));
300          case 2: return new CE(getMessage());
301          case 3: return new TS(getMessage());
302          case 4: return new NM(getMessage());
303          case 5: return new CE(getMessage());
304          case 6: return new NM(getMessage());
305          case 7: return new CE(getMessage());
306          case 8: return new IS(getMessage(), new Integer( 279 ));
307          case 9: return new CE(getMessage());
308          default: return null;
309       }
310   }
311
312
313}
314