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.message;
035
036import ca.uhn.hl7v2.model.v24.group.*;
037import ca.uhn.hl7v2.model.v24.segment.*;
038
039import java.util.List;
040
041import ca.uhn.hl7v2.HL7Exception;
042import ca.uhn.hl7v2.parser.ModelClassFactory;
043import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
044import ca.uhn.hl7v2.model.AbstractMessage;
045
046/**
047 * <p>Represents a RSP_K25 message structure (see chapter 15). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message Header) <b> </b></li>
051                 * <li>2: MSA (Message Acknowledgment) <b> </b></li>
052                 * <li>3: ERR (Error) <b>optional </b></li>
053                 * <li>4: QAK (Query Acknowledgment) <b> </b></li>
054                 * <li>5: QPD (Query Parameter Definition) <b> </b></li>
055                 * <li>6: RCP (Response Control Parameter) <b> </b></li>
056                 * <li>7: RSP_K25_STAFF (a Group object) <b> repeating</b></li>
057                 * <li>8: DSC (Continuation Pointer) <b>optional </b></li>
058 * </ul>
059 */
060@SuppressWarnings("unused")
061public class RSP_K25 extends AbstractMessage  {
062
063    /**
064     * Creates a new RSP_K25 message with DefaultModelClassFactory. 
065     */ 
066    public RSP_K25() { 
067       this(new DefaultModelClassFactory());
068    }
069
070    /** 
071     * Creates a new RSP_K25 message with custom ModelClassFactory.
072     */
073    public RSP_K25(ModelClassFactory factory) {
074       super(factory);
075       init(factory);
076    }
077
078    private void init(ModelClassFactory factory) {
079       try {
080                          this.add(MSH.class, true, false);
081                          this.add(MSA.class, true, false);
082                          this.add(ERR.class, false, false);
083                          this.add(QAK.class, true, false);
084                          this.add(QPD.class, true, false);
085                          this.add(RCP.class, true, false);
086                          this.add(RSP_K25_STAFF.class, true, true);
087                          this.add(DSC.class, false, false);
088       } catch(HL7Exception e) {
089          log.error("Unexpected error creating RSP_K25 - this is probably a bug in the source code generator.", e);
090       }
091    }
092
093    /** 
094     * Returns "2.4"
095     */
096    public String getVersion() {
097       return "2.4";
098    }
099
100
101
102    /**
103     * Returns
104     * MSH (Message Header) - creates it if necessary
105     */
106    public MSH getMSH() { 
107       return getTyped("MSH", MSH.class);
108    }
109
110
111
112
113    /**
114     * Returns
115     * MSA (Message Acknowledgment) - creates it if necessary
116     */
117    public MSA getMSA() { 
118       return getTyped("MSA", MSA.class);
119    }
120
121
122
123
124    /**
125     * Returns
126     * ERR (Error) - creates it if necessary
127     */
128    public ERR getERR() { 
129       return getTyped("ERR", ERR.class);
130    }
131
132
133
134
135    /**
136     * Returns
137     * QAK (Query Acknowledgment) - creates it if necessary
138     */
139    public QAK getQAK() { 
140       return getTyped("QAK", QAK.class);
141    }
142
143
144
145
146    /**
147     * Returns
148     * QPD (Query Parameter Definition) - creates it if necessary
149     */
150    public QPD getQPD() { 
151       return getTyped("QPD", QPD.class);
152    }
153
154
155
156
157    /**
158     * Returns
159     * RCP (Response Control Parameter) - creates it if necessary
160     */
161    public RCP getRCP() { 
162       return getTyped("RCP", RCP.class);
163    }
164
165
166
167
168    /**
169     * Returns
170     * the first repetition of 
171     * STAFF (a Group object) - creates it if necessary
172     */
173    public RSP_K25_STAFF getSTAFF() { 
174       return getTyped("STAFF", RSP_K25_STAFF.class);
175    }
176
177
178    /**
179     * Returns a specific repetition of
180     * STAFF (a Group object) - creates it if necessary
181     *
182     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
183     * @throws HL7Exception if the repetition requested is more than one 
184     *     greater than the number of existing repetitions.
185     */
186    public RSP_K25_STAFF getSTAFF(int rep) { 
187       return getTyped("STAFF", rep, RSP_K25_STAFF.class);
188    }
189
190    /** 
191     * Returns the number of existing repetitions of STAFF 
192     */ 
193    public int getSTAFFReps() { 
194        return getReps("STAFF");
195    } 
196
197    /** 
198     * <p>
199     * Returns a non-modifiable List containing all current existing repetitions of STAFF.
200     * <p>
201     * <p>
202     * Note that unlike {@link #getSTAFF()}, this method will not create any reps
203     * if none are already present, so an empty list may be returned.
204     * </p>
205     */ 
206    public List<RSP_K25_STAFF> getSTAFFAll() throws HL7Exception {
207        return getAllAsList("STAFF", RSP_K25_STAFF.class);
208    } 
209
210    /**
211     * Inserts a specific repetition of STAFF (a Group object)
212     * @see AbstractGroup#insertRepetition(Structure, int) 
213     */
214    public void insertSTAFF(RSP_K25_STAFF structure, int rep) throws HL7Exception { 
215       super.insertRepetition( "STAFF", structure, rep);
216    }
217
218
219    /**
220     * Inserts a specific repetition of STAFF (a Group object)
221     * @see AbstractGroup#insertRepetition(Structure, int) 
222     */
223    public RSP_K25_STAFF insertSTAFF(int rep) throws HL7Exception { 
224       return (RSP_K25_STAFF)super.insertRepetition("STAFF", rep);
225    }
226
227
228    /**
229     * Removes a specific repetition of STAFF (a Group object)
230     * @see AbstractGroup#removeRepetition(String, int) 
231     */
232    public RSP_K25_STAFF removeSTAFF(int rep) throws HL7Exception { 
233       return (RSP_K25_STAFF)super.removeRepetition("STAFF", rep);
234    }
235
236
237
238    /**
239     * Returns
240     * DSC (Continuation Pointer) - creates it if necessary
241     */
242    public DSC getDSC() { 
243       return getTyped("DSC", DSC.class);
244    }
245
246
247
248
249}
250