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