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.v251.segment;
035
036// import ca.uhn.hl7v2.model.v251.group.*;
037import ca.uhn.hl7v2.model.v251.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 VTQ message segment (Virtual Table Query Request). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>VTQ-1: Query Tag (ST) <b>optional </b>
052     * <li>VTQ-2: Query/Response Format Code (ID) <b> </b>
053     * <li>VTQ-3: VT Query Name (CE) <b> </b>
054     * <li>VTQ-4: Virtual Table Name (CE) <b> </b>
055     * <li>VTQ-5: Selection Criteria (QSC) <b>optional repeating</b>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class VTQ extends AbstractSegment {
060
061    /** 
062     * Creates a new VTQ segment
063     */
064    public VTQ(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                                  this.add(ST.class, false, 1, 32, new Object[]{ getMessage() }, "Query Tag");
072                                              this.add(ID.class, true, 1, 1, new Object[]{ getMessage(), new Integer(106) }, "Query/Response Format Code");
073                                  this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "VT Query Name");
074                                  this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "Virtual Table Name");
075                                  this.add(QSC.class, false, 0, 256, new Object[]{ getMessage() }, "Selection Criteria");
076       } catch(HL7Exception e) {
077          log.error("Unexpected error creating VTQ - this is probably a bug in the source code generator.", e);
078       }
079    }
080
081
082
083    /**
084     * Returns
085     * VTQ-1: "Query Tag" - creates it if necessary
086     */
087    public ST getQueryTag() { 
088                ST retVal = this.getTypedField(1, 0);
089                return retVal;
090    }
091    
092    /**
093     * Returns
094     * VTQ-1: "Query Tag" - creates it if necessary
095     */
096    public ST getVtq1_QueryTag() { 
097                ST retVal = this.getTypedField(1, 0);
098                return retVal;
099    }
100
101
102
103    /**
104     * Returns
105     * VTQ-2: "Query/Response Format Code" - creates it if necessary
106     */
107    public ID getQueryResponseFormatCode() { 
108                ID retVal = this.getTypedField(2, 0);
109                return retVal;
110    }
111    
112    /**
113     * Returns
114     * VTQ-2: "Query/Response Format Code" - creates it if necessary
115     */
116    public ID getVtq2_QueryResponseFormatCode() { 
117                ID retVal = this.getTypedField(2, 0);
118                return retVal;
119    }
120
121
122
123    /**
124     * Returns
125     * VTQ-3: "VT Query Name" - creates it if necessary
126     */
127    public CE getVTQueryName() { 
128                CE retVal = this.getTypedField(3, 0);
129                return retVal;
130    }
131    
132    /**
133     * Returns
134     * VTQ-3: "VT Query Name" - creates it if necessary
135     */
136    public CE getVtq3_VTQueryName() { 
137                CE retVal = this.getTypedField(3, 0);
138                return retVal;
139    }
140
141
142
143    /**
144     * Returns
145     * VTQ-4: "Virtual Table Name" - creates it if necessary
146     */
147    public CE getVirtualTableName() { 
148                CE retVal = this.getTypedField(4, 0);
149                return retVal;
150    }
151    
152    /**
153     * Returns
154     * VTQ-4: "Virtual Table Name" - creates it if necessary
155     */
156    public CE getVtq4_VirtualTableName() { 
157                CE retVal = this.getTypedField(4, 0);
158                return retVal;
159    }
160
161
162    /**
163     * Returns all repetitions of Selection Criteria (VTQ-5).
164     */
165    public QSC[] getSelectionCriteria() {
166        QSC[] retVal = this.getTypedField(5, new QSC[0]);
167        return retVal;
168    }
169
170
171    /**
172     * Returns all repetitions of Selection Criteria (VTQ-5).
173     */
174    public QSC[] getVtq5_SelectionCriteria() {
175        QSC[] retVal = this.getTypedField(5, new QSC[0]);
176        return retVal;
177    }
178
179
180    /**
181     * Returns a count of the current number of repetitions of Selection Criteria (VTQ-5).
182     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
183     * it will return zero.
184     */
185    public int getSelectionCriteriaReps() {
186        return this.getReps(5);
187    }
188
189
190    /**
191     * Returns a specific repetition of
192     * VTQ-5: "Selection Criteria" - creates it if necessary
193     *
194     * @param rep The repetition index (0-indexed)
195     */
196    public QSC getSelectionCriteria(int rep) { 
197                QSC retVal = this.getTypedField(5, rep);
198                return retVal;
199    }
200
201    /**
202     * Returns a specific repetition of
203     * VTQ-5: "Selection Criteria" - creates it if necessary
204     *
205     * @param rep The repetition index (0-indexed)
206     */
207    public QSC getVtq5_SelectionCriteria(int rep) { 
208                QSC retVal = this.getTypedField(5, rep);
209                return retVal;
210    }
211
212    /**
213     * Returns a count of the current number of repetitions of Selection Criteria (VTQ-5).
214     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
215     * it will return zero.
216     */
217    public int getVtq5_SelectionCriteriaReps() {
218        return this.getReps(5);
219    }
220
221
222    /**
223     * Inserts a repetition of
224     * VTQ-5: "Selection Criteria" at a specific index
225     *
226     * @param rep The repetition index (0-indexed)
227     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
228     */
229    public QSC insertSelectionCriteria(int rep) throws HL7Exception { 
230        return (QSC) super.insertRepetition(5, rep);
231    }
232
233
234    /**
235     * Inserts a repetition of
236     * VTQ-5: "Selection Criteria" at a specific index
237     *
238     * @param rep The repetition index (0-indexed)
239     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
240     */
241    public QSC insertVtq5_SelectionCriteria(int rep) throws HL7Exception { 
242        return (QSC) super.insertRepetition(5, rep);
243    }
244
245
246    /**
247     * Removes a repetition of
248     * VTQ-5: "Selection Criteria" at a specific index
249     *
250     * @param rep The repetition index (0-indexed)
251     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
252     */
253    public QSC removeSelectionCriteria(int rep) throws HL7Exception { 
254        return (QSC) super.removeRepetition(5, rep);
255    }
256
257
258    /**
259     * Removes a repetition of
260     * VTQ-5: "Selection Criteria" at a specific index
261     *
262     * @param rep The repetition index (0-indexed)
263     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
264     */
265    public QSC removeVtq5_SelectionCriteria(int rep) throws HL7Exception { 
266        return (QSC) super.removeRepetition(5, rep);
267    }
268
269
270
271
272
273
274    /** {@inheritDoc} */   
275    protected Type createNewTypeWithoutReflection(int field) {
276       switch (field) {
277          case 0: return new ST(getMessage());
278          case 1: return new ID(getMessage(), new Integer( 106 ));
279          case 2: return new CE(getMessage());
280          case 3: return new CE(getMessage());
281          case 4: return new QSC(getMessage());
282          default: return null;
283       }
284   }
285
286
287}
288