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.v27.message;
035
036import ca.uhn.hl7v2.model.v27.group.*;
037import ca.uhn.hl7v2.model.v27.segment.*;
038
039import ca.uhn.hl7v2.HL7Exception;
040import ca.uhn.hl7v2.parser.ModelClassFactory;
041import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044
045/**
046 * <p>Represents a RSP_E22 message structure (see chapter 16.3.13). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (Message Header) <b> </b> </li>
050                                 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li>
051                                 * <li>3: UAC (User Authentication Credential Segment) <b>optional repeating</b> </li>
052                                 * <li>4: MSA (Message Acknowledgment) <b> </b> </li>
053                                 * <li>5: ERR (Error) <b>optional repeating</b> </li>
054                                 * <li>6: QAK (Query Acknowledgment) <b> </b> </li>
055                                 * <li>7: QPD (Query Parameter Definition) <b> </b> </li>
056                                 * <li>8: RSP_E22_AUTHORIZATION_INFO (a Group object) <b>optional </b> </li>
057 * </ul>
058 */
059//@SuppressWarnings("unused")
060public class RSP_E22 extends AbstractMessage  {
061
062    /**
063     * Creates a new RSP_E22 message with DefaultModelClassFactory. 
064     */ 
065    public RSP_E22() { 
066       this(new DefaultModelClassFactory());
067    }
068
069    /** 
070     * Creates a new RSP_E22 message with custom ModelClassFactory.
071     */
072    public RSP_E22(ModelClassFactory factory) {
073       super(factory);
074       init(factory);
075    }
076
077    private void init(ModelClassFactory factory) {
078       try {
079                          this.add(MSH.class, true, false);
080                                  this.add(SFT.class, false, true);
081                                  this.add(UAC.class, false, true);
082                                  this.add(MSA.class, true, false);
083                                  this.add(ERR.class, false, true);
084                                  this.add(QAK.class, true, false);
085                                  this.add(QPD.class, true, false);
086                                  this.add(RSP_E22_AUTHORIZATION_INFO.class, false, false);
087               } catch(HL7Exception e) {
088          log.error("Unexpected error creating RSP_E22 - this is probably a bug in the source code generator.", e);
089       }
090    }
091
092
093    /** 
094     * Returns "2.7"
095     */
096    public String getVersion() {
097       return "2.7";
098    }
099
100
101
102
103    /**
104     * <p>
105     * Returns
106     * MSH (Message Header) - creates it if necessary
107     * </p>
108     * 
109     *
110     */
111    public MSH getMSH() { 
112       return getTyped("MSH", MSH.class);
113    }
114
115
116
117
118
119    /**
120     * <p>
121     * Returns
122     * the first repetition of 
123     * SFT (Software Segment) - creates it if necessary
124     * </p>
125     * 
126     *
127     */
128    public SFT getSFT() { 
129       return getTyped("SFT", SFT.class);
130    }
131
132
133    /**
134     * <p>
135     * Returns a specific repetition of
136     * SFT (Software Segment) - creates it if necessary
137     * </p>
138     * 
139     *
140     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
141     * @throws HL7Exception if the repetition requested is more than one 
142     *     greater than the number of existing repetitions.
143     */
144    public SFT getSFT(int rep) { 
145       return getTyped("SFT", rep, SFT.class);
146    }
147
148    /** 
149     * <p>
150     * Returns the number of existing repetitions of SFT 
151     * </p>
152     * 
153     */ 
154    public int getSFTReps() { 
155        return getReps("SFT");
156    } 
157
158    /** 
159     * <p>
160     * Returns a non-modifiable List containing all current existing repetitions of SFT.
161     * <p>
162     * <p>
163     * Note that unlike {@link #getSFT()}, this method will not create any reps
164     * if none are already present, so an empty list may be returned.
165     * </p>
166     * 
167     */ 
168    public java.util.List<SFT> getSFTAll() throws HL7Exception {
169        return getAllAsList("SFT", SFT.class);
170    } 
171
172    /**
173     * <p>
174     * Inserts a specific repetition of SFT (Software Segment)
175     * </p>
176     * 
177     *
178     * @see AbstractGroup#insertRepetition(Structure, int) 
179     */
180    public void insertSFT(SFT structure, int rep) throws HL7Exception { 
181       super.insertRepetition( "SFT", structure, rep);
182    }
183
184
185    /**
186     * <p>
187     * Inserts a specific repetition of SFT (Software Segment)
188     * </p>
189     * 
190     *
191     * @see AbstractGroup#insertRepetition(Structure, int) 
192     */
193    public SFT insertSFT(int rep) throws HL7Exception { 
194       return (SFT)super.insertRepetition("SFT", rep);
195    }
196
197
198    /**
199     * <p>
200     * Removes a specific repetition of SFT (Software Segment)
201     * </p>
202     * 
203     *
204     * @see AbstractGroup#removeRepetition(String, int) 
205     */
206    public SFT removeSFT(int rep) throws HL7Exception { 
207       return (SFT)super.removeRepetition("SFT", rep);
208    }
209
210
211
212
213    /**
214     * <p>
215     * Returns
216     * the first repetition of 
217     * UAC (User Authentication Credential Segment) - creates it if necessary
218     * </p>
219     * 
220     *
221     */
222    public UAC getUAC() { 
223       return getTyped("UAC", UAC.class);
224    }
225
226
227    /**
228     * <p>
229     * Returns a specific repetition of
230     * UAC (User Authentication Credential Segment) - creates it if necessary
231     * </p>
232     * 
233     *
234     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
235     * @throws HL7Exception if the repetition requested is more than one 
236     *     greater than the number of existing repetitions.
237     */
238    public UAC getUAC(int rep) { 
239       return getTyped("UAC", rep, UAC.class);
240    }
241
242    /** 
243     * <p>
244     * Returns the number of existing repetitions of UAC 
245     * </p>
246     * 
247     */ 
248    public int getUACReps() { 
249        return getReps("UAC");
250    } 
251
252    /** 
253     * <p>
254     * Returns a non-modifiable List containing all current existing repetitions of UAC.
255     * <p>
256     * <p>
257     * Note that unlike {@link #getUAC()}, this method will not create any reps
258     * if none are already present, so an empty list may be returned.
259     * </p>
260     * 
261     */ 
262    public java.util.List<UAC> getUACAll() throws HL7Exception {
263        return getAllAsList("UAC", UAC.class);
264    } 
265
266    /**
267     * <p>
268     * Inserts a specific repetition of UAC (User Authentication Credential Segment)
269     * </p>
270     * 
271     *
272     * @see AbstractGroup#insertRepetition(Structure, int) 
273     */
274    public void insertUAC(UAC structure, int rep) throws HL7Exception { 
275       super.insertRepetition( "UAC", structure, rep);
276    }
277
278
279    /**
280     * <p>
281     * Inserts a specific repetition of UAC (User Authentication Credential Segment)
282     * </p>
283     * 
284     *
285     * @see AbstractGroup#insertRepetition(Structure, int) 
286     */
287    public UAC insertUAC(int rep) throws HL7Exception { 
288       return (UAC)super.insertRepetition("UAC", rep);
289    }
290
291
292    /**
293     * <p>
294     * Removes a specific repetition of UAC (User Authentication Credential Segment)
295     * </p>
296     * 
297     *
298     * @see AbstractGroup#removeRepetition(String, int) 
299     */
300    public UAC removeUAC(int rep) throws HL7Exception { 
301       return (UAC)super.removeRepetition("UAC", rep);
302    }
303
304
305
306
307    /**
308     * <p>
309     * Returns
310     * MSA (Message Acknowledgment) - creates it if necessary
311     * </p>
312     * 
313     *
314     */
315    public MSA getMSA() { 
316       return getTyped("MSA", MSA.class);
317    }
318
319
320
321
322
323    /**
324     * <p>
325     * Returns
326     * the first repetition of 
327     * ERR (Error) - creates it if necessary
328     * </p>
329     * 
330     *
331     */
332    public ERR getERR() { 
333       return getTyped("ERR", ERR.class);
334    }
335
336
337    /**
338     * <p>
339     * Returns a specific repetition of
340     * ERR (Error) - creates it if necessary
341     * </p>
342     * 
343     *
344     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
345     * @throws HL7Exception if the repetition requested is more than one 
346     *     greater than the number of existing repetitions.
347     */
348    public ERR getERR(int rep) { 
349       return getTyped("ERR", rep, ERR.class);
350    }
351
352    /** 
353     * <p>
354     * Returns the number of existing repetitions of ERR 
355     * </p>
356     * 
357     */ 
358    public int getERRReps() { 
359        return getReps("ERR");
360    } 
361
362    /** 
363     * <p>
364     * Returns a non-modifiable List containing all current existing repetitions of ERR.
365     * <p>
366     * <p>
367     * Note that unlike {@link #getERR()}, this method will not create any reps
368     * if none are already present, so an empty list may be returned.
369     * </p>
370     * 
371     */ 
372    public java.util.List<ERR> getERRAll() throws HL7Exception {
373        return getAllAsList("ERR", ERR.class);
374    } 
375
376    /**
377     * <p>
378     * Inserts a specific repetition of ERR (Error)
379     * </p>
380     * 
381     *
382     * @see AbstractGroup#insertRepetition(Structure, int) 
383     */
384    public void insertERR(ERR structure, int rep) throws HL7Exception { 
385       super.insertRepetition( "ERR", structure, rep);
386    }
387
388
389    /**
390     * <p>
391     * Inserts a specific repetition of ERR (Error)
392     * </p>
393     * 
394     *
395     * @see AbstractGroup#insertRepetition(Structure, int) 
396     */
397    public ERR insertERR(int rep) throws HL7Exception { 
398       return (ERR)super.insertRepetition("ERR", rep);
399    }
400
401
402    /**
403     * <p>
404     * Removes a specific repetition of ERR (Error)
405     * </p>
406     * 
407     *
408     * @see AbstractGroup#removeRepetition(String, int) 
409     */
410    public ERR removeERR(int rep) throws HL7Exception { 
411       return (ERR)super.removeRepetition("ERR", rep);
412    }
413
414
415
416
417    /**
418     * <p>
419     * Returns
420     * QAK (Query Acknowledgment) - creates it if necessary
421     * </p>
422     * 
423     *
424     */
425    public QAK getQAK() { 
426       return getTyped("QAK", QAK.class);
427    }
428
429
430
431
432
433    /**
434     * <p>
435     * Returns
436     * QPD (Query Parameter Definition) - creates it if necessary
437     * </p>
438     * 
439     *
440     */
441    public QPD getQPD() { 
442       return getTyped("QPD", QPD.class);
443    }
444
445
446
447
448
449    /**
450     * <p>
451     * Returns
452     * AUTHORIZATION_INFO (a Group object) - creates it if necessary
453     * </p>
454     * 
455     *
456     */
457    public RSP_E22_AUTHORIZATION_INFO getAUTHORIZATION_INFO() { 
458       return getTyped("AUTHORIZATION_INFO", RSP_E22_AUTHORIZATION_INFO.class);
459    }
460
461
462
463
464}
465