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.v24.segment;
035
036// import ca.uhn.hl7v2.model.v24.group.*;
037import ca.uhn.hl7v2.model.v24.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 QAK message segment (Query Acknowledgment). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>QAK-1: Query Tag (ST) <b>optional </b>
052     * <li>QAK-2: Query Response Status (ID) <b>optional </b>
053     * <li>QAK-3: Message Query Name (CE) <b>optional </b>
054     * <li>QAK-4: Hit Count Total (NM) <b>optional </b>
055     * <li>QAK-5: This payload (NM) <b>optional </b>
056     * <li>QAK-6: Hits remaining (NM) <b>optional </b>
057 * </ul>
058 */
059@SuppressWarnings("unused")
060public class QAK extends AbstractSegment {
061
062    /** 
063     * Creates a new QAK segment
064     */
065    public QAK(Group parent, ModelClassFactory factory) {
066       super(parent, factory);
067       init(factory);
068    }
069
070    private void init(ModelClassFactory factory) {
071       try {
072                                  this.add(ST.class, false, 1, 32, new Object[]{ getMessage() }, "Query Tag");
073                                              this.add(ID.class, false, 1, 2, new Object[]{ getMessage(), new Integer(208) }, "Query Response Status");
074                                  this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Message Query Name");
075                                  this.add(NM.class, false, 1, 10, new Object[]{ getMessage() }, "Hit Count Total");
076                                  this.add(NM.class, false, 1, 10, new Object[]{ getMessage() }, "This payload");
077                                  this.add(NM.class, false, 1, 10, new Object[]{ getMessage() }, "Hits remaining");
078       } catch(HL7Exception e) {
079          log.error("Unexpected error creating QAK - this is probably a bug in the source code generator.", e);
080       }
081    }
082
083
084
085    /**
086     * Returns
087     * QAK-1: "Query Tag" - creates it if necessary
088     */
089    public ST getQueryTag() { 
090                ST retVal = this.getTypedField(1, 0);
091                return retVal;
092    }
093    
094    /**
095     * Returns
096     * QAK-1: "Query Tag" - creates it if necessary
097     */
098    public ST getQak1_QueryTag() { 
099                ST retVal = this.getTypedField(1, 0);
100                return retVal;
101    }
102
103
104
105    /**
106     * Returns
107     * QAK-2: "Query Response Status" - creates it if necessary
108     */
109    public ID getQueryResponseStatus() { 
110                ID retVal = this.getTypedField(2, 0);
111                return retVal;
112    }
113    
114    /**
115     * Returns
116     * QAK-2: "Query Response Status" - creates it if necessary
117     */
118    public ID getQak2_QueryResponseStatus() { 
119                ID retVal = this.getTypedField(2, 0);
120                return retVal;
121    }
122
123
124
125    /**
126     * Returns
127     * QAK-3: "Message Query Name" - creates it if necessary
128     */
129    public CE getMessageQueryName() { 
130                CE retVal = this.getTypedField(3, 0);
131                return retVal;
132    }
133    
134    /**
135     * Returns
136     * QAK-3: "Message Query Name" - creates it if necessary
137     */
138    public CE getQak3_MessageQueryName() { 
139                CE retVal = this.getTypedField(3, 0);
140                return retVal;
141    }
142
143
144
145    /**
146     * Returns
147     * QAK-4: "Hit Count Total" - creates it if necessary
148     */
149    public NM getHitCountTotal() { 
150                NM retVal = this.getTypedField(4, 0);
151                return retVal;
152    }
153    
154    /**
155     * Returns
156     * QAK-4: "Hit Count Total" - creates it if necessary
157     */
158    public NM getQak4_HitCountTotal() { 
159                NM retVal = this.getTypedField(4, 0);
160                return retVal;
161    }
162
163
164
165    /**
166     * Returns
167     * QAK-5: "This payload" - creates it if necessary
168     */
169    public NM getThisPayload() { 
170                NM retVal = this.getTypedField(5, 0);
171                return retVal;
172    }
173    
174    /**
175     * Returns
176     * QAK-5: "This payload" - creates it if necessary
177     */
178    public NM getQak5_ThisPayload() { 
179                NM retVal = this.getTypedField(5, 0);
180                return retVal;
181    }
182
183
184
185    /**
186     * Returns
187     * QAK-6: "Hits remaining" - creates it if necessary
188     */
189    public NM getHitsRemaining() { 
190                NM retVal = this.getTypedField(6, 0);
191                return retVal;
192    }
193    
194    /**
195     * Returns
196     * QAK-6: "Hits remaining" - creates it if necessary
197     */
198    public NM getQak6_HitsRemaining() { 
199                NM retVal = this.getTypedField(6, 0);
200                return retVal;
201    }
202
203
204
205
206
207    /** {@inheritDoc} */   
208    protected Type createNewTypeWithoutReflection(int field) {
209       switch (field) {
210          case 0: return new ST(getMessage());
211          case 1: return new ID(getMessage(), new Integer( 208 ));
212          case 2: return new CE(getMessage());
213          case 3: return new NM(getMessage());
214          case 4: return new NM(getMessage());
215          case 5: return new NM(getMessage());
216          default: return null;
217       }
218   }
219
220
221}
222