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