View Javadoc
1   /*
2    * This class is an auto-generated source file for a HAPI
3    * HL7 v2.x standard structure class.
4    *
5    * For more information, visit: http://hl7api.sourceforge.net/
6    * 
7    * The contents of this file are subject to the Mozilla Public License Version 1.1 
8    * (the "License"); you may not use this file except in compliance with the License. 
9    * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
10   * Software distributed under the License is distributed on an "AS IS" basis, 
11   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
12   * specific language governing rights and limitations under the License. 
13   * 
14   * The Original Code is "[file_name]".  Description: 
15   * "[one_line_description]" 
16   * 
17   * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
18   * 2012.  All Rights Reserved. 
19   * 
20   * Contributor(s): ______________________________________. 
21   * 
22   * Alternatively, the contents of this file may be used under the terms of the 
23   * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
24   * applicable instead of those above.  If you wish to allow use of your version of this 
25   * file only under the terms of the GPL and not to allow others to use your version 
26   * of this file under the MPL, indicate your decision by deleting  the provisions above 
27   * and replace  them with the notice and other provisions required by the GPL License.  
28   * If you do not delete the provisions above, a recipient may use your version of 
29   * this file under either the MPL or the GPL. 
30   * 
31   */
32  
33  
34  package ca.uhn.hl7v2.model.v231.segment;
35  
36  // import ca.uhn.hl7v2.model.v231.group.*;
37  import ca.uhn.hl7v2.model.v231.datatype.*;
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
41  import ca.uhn.hl7v2.model.AbstractMessage;
42  import ca.uhn.hl7v2.model.Group;
43  import ca.uhn.hl7v2.model.Type;
44  import ca.uhn.hl7v2.model.AbstractSegment;
45  import ca.uhn.hl7v2.model.Varies;
46  
47  
48  /**
49   *<p>Represents an HL7 AIS message segment (AIS - appointment information - service segment). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>AIS-1: Set ID - AIS (SI) <b> </b>
53       * <li>AIS-2: Segment Action Code (ID) <b>optional </b>
54       * <li>AIS-3: Universal Service ID (CE) <b> </b>
55       * <li>AIS-4: Start Date/Time (TS) <b>optional </b>
56       * <li>AIS-5: Start Date/Time Offset (NM) <b>optional </b>
57       * <li>AIS-6: Start Date/Time Offset Units (CE) <b>optional </b>
58       * <li>AIS-7: Duration (NM) <b>optional </b>
59       * <li>AIS-8: Duration Units (CE) <b>optional </b>
60       * <li>AIS-9: Allow Substitution Code (IS) <b>optional </b>
61       * <li>AIS-10: Filler Status Code (CE) <b>optional </b>
62   * </ul>
63   */
64  @SuppressWarnings("unused")
65  public class AIS extends AbstractSegment {
66  
67      /** 
68       * Creates a new AIS segment
69       */
70      public AIS(Group parent, ModelClassFactory factory) {
71         super(parent, factory);
72         init(factory);
73      }
74  
75      private void init(ModelClassFactory factory) {
76         try {
77                                    this.add(SI.class, true, 1, 4, new Object[]{ getMessage() }, "Set ID - AIS");
78                                                this.add(ID.class, false, 1, 3, new Object[]{ getMessage(), new Integer(206) }, "Segment Action Code");
79                                    this.add(CE.class, true, 1, 200, new Object[]{ getMessage() }, "Universal Service ID");
80                                    this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Start Date/Time");
81                                    this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Start Date/Time Offset");
82                                    this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Start Date/Time Offset Units");
83                                    this.add(NM.class, false, 1, 20, new Object[]{ getMessage() }, "Duration");
84                                    this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Duration Units");
85                                                this.add(IS.class, false, 1, 10, new Object[]{ getMessage(), new Integer(279) }, "Allow Substitution Code");
86                                    this.add(CE.class, false, 1, 200, new Object[]{ getMessage() }, "Filler Status Code");
87         } catch(HL7Exception e) {
88            log.error("Unexpected error creating AIS - this is probably a bug in the source code generator.", e);
89         }
90      }
91  
92  
93  
94      /**
95       * Returns
96       * AIS-1: "Set ID - AIS" - creates it if necessary
97       */
98      public SI getSetIDAIS() { 
99  		SI retVal = this.getTypedField(1, 0);
100 		return retVal;
101     }
102     
103     /**
104      * Returns
105      * AIS-1: "Set ID - AIS" - creates it if necessary
106      */
107     public SI getAis1_SetIDAIS() { 
108 		SI retVal = this.getTypedField(1, 0);
109 		return retVal;
110     }
111 
112 
113 
114     /**
115      * Returns
116      * AIS-2: "Segment Action Code" - creates it if necessary
117      */
118     public ID getSegmentActionCode() { 
119 		ID retVal = this.getTypedField(2, 0);
120 		return retVal;
121     }
122     
123     /**
124      * Returns
125      * AIS-2: "Segment Action Code" - creates it if necessary
126      */
127     public ID getAis2_SegmentActionCode() { 
128 		ID retVal = this.getTypedField(2, 0);
129 		return retVal;
130     }
131 
132 
133 
134     /**
135      * Returns
136      * AIS-3: "Universal Service ID" - creates it if necessary
137      */
138     public CE getUniversalServiceID() { 
139 		CE retVal = this.getTypedField(3, 0);
140 		return retVal;
141     }
142     
143     /**
144      * Returns
145      * AIS-3: "Universal Service ID" - creates it if necessary
146      */
147     public CE getAis3_UniversalServiceID() { 
148 		CE retVal = this.getTypedField(3, 0);
149 		return retVal;
150     }
151 
152 
153 
154     /**
155      * Returns
156      * AIS-4: "Start Date/Time" - creates it if necessary
157      */
158     public TS getStartDateTime() { 
159 		TS retVal = this.getTypedField(4, 0);
160 		return retVal;
161     }
162     
163     /**
164      * Returns
165      * AIS-4: "Start Date/Time" - creates it if necessary
166      */
167     public TS getAis4_StartDateTime() { 
168 		TS retVal = this.getTypedField(4, 0);
169 		return retVal;
170     }
171 
172 
173 
174     /**
175      * Returns
176      * AIS-5: "Start Date/Time Offset" - creates it if necessary
177      */
178     public NM getStartDateTimeOffset() { 
179 		NM retVal = this.getTypedField(5, 0);
180 		return retVal;
181     }
182     
183     /**
184      * Returns
185      * AIS-5: "Start Date/Time Offset" - creates it if necessary
186      */
187     public NM getAis5_StartDateTimeOffset() { 
188 		NM retVal = this.getTypedField(5, 0);
189 		return retVal;
190     }
191 
192 
193 
194     /**
195      * Returns
196      * AIS-6: "Start Date/Time Offset Units" - creates it if necessary
197      */
198     public CE getStartDateTimeOffsetUnits() { 
199 		CE retVal = this.getTypedField(6, 0);
200 		return retVal;
201     }
202     
203     /**
204      * Returns
205      * AIS-6: "Start Date/Time Offset Units" - creates it if necessary
206      */
207     public CE getAis6_StartDateTimeOffsetUnits() { 
208 		CE retVal = this.getTypedField(6, 0);
209 		return retVal;
210     }
211 
212 
213 
214     /**
215      * Returns
216      * AIS-7: "Duration" - creates it if necessary
217      */
218     public NM getDuration() { 
219 		NM retVal = this.getTypedField(7, 0);
220 		return retVal;
221     }
222     
223     /**
224      * Returns
225      * AIS-7: "Duration" - creates it if necessary
226      */
227     public NM getAis7_Duration() { 
228 		NM retVal = this.getTypedField(7, 0);
229 		return retVal;
230     }
231 
232 
233 
234     /**
235      * Returns
236      * AIS-8: "Duration Units" - creates it if necessary
237      */
238     public CE getDurationUnits() { 
239 		CE retVal = this.getTypedField(8, 0);
240 		return retVal;
241     }
242     
243     /**
244      * Returns
245      * AIS-8: "Duration Units" - creates it if necessary
246      */
247     public CE getAis8_DurationUnits() { 
248 		CE retVal = this.getTypedField(8, 0);
249 		return retVal;
250     }
251 
252 
253 
254     /**
255      * Returns
256      * AIS-9: "Allow Substitution Code" - creates it if necessary
257      */
258     public IS getAllowSubstitutionCode() { 
259 		IS retVal = this.getTypedField(9, 0);
260 		return retVal;
261     }
262     
263     /**
264      * Returns
265      * AIS-9: "Allow Substitution Code" - creates it if necessary
266      */
267     public IS getAis9_AllowSubstitutionCode() { 
268 		IS retVal = this.getTypedField(9, 0);
269 		return retVal;
270     }
271 
272 
273 
274     /**
275      * Returns
276      * AIS-10: "Filler Status Code" - creates it if necessary
277      */
278     public CE getFillerStatusCode() { 
279 		CE retVal = this.getTypedField(10, 0);
280 		return retVal;
281     }
282     
283     /**
284      * Returns
285      * AIS-10: "Filler Status Code" - creates it if necessary
286      */
287     public CE getAis10_FillerStatusCode() { 
288 		CE retVal = this.getTypedField(10, 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 SI(getMessage());
300           case 1: return new ID(getMessage(), new Integer( 206 ));
301           case 2: return new CE(getMessage());
302           case 3: return new TS(getMessage());
303           case 4: return new NM(getMessage());
304           case 5: return new CE(getMessage());
305           case 6: return new NM(getMessage());
306           case 7: return new CE(getMessage());
307           case 8: return new IS(getMessage(), new Integer( 279 ));
308           case 9: return new CE(getMessage());
309           default: return null;
310        }
311    }
312 
313 
314 }
315