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 RDR_RDR message structure (see chapter 5.9.1.0). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (Message Header) <b> </b> </li>
050                                 * <li>2: MSA (Message Acknowledgment) <b> </b> </li>
051                                 * <li>3: ERR (Error) <b>optional repeating</b> </li>
052                                 * <li>4: SFT (Software Segment) <b>optional </b> </li>
053                                 * <li>5: UAC (User Authentication Credential Segment) <b>optional </b> </li>
054                                 * <li>6: RDR_RDR_DEFINITION (a Group object) <b> repeating</b> </li>
055                                 * <li>7: DSC (Continuation Pointer) <b>optional </b> </li>
056 * </ul>
057 */
058//@SuppressWarnings("unused")
059public class RDR_RDR extends AbstractMessage  {
060
061    /**
062     * Creates a new RDR_RDR message with DefaultModelClassFactory. 
063     */ 
064    public RDR_RDR() { 
065       this(new DefaultModelClassFactory());
066    }
067
068    /** 
069     * Creates a new RDR_RDR message with custom ModelClassFactory.
070     */
071    public RDR_RDR(ModelClassFactory factory) {
072       super(factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                          this.add(MSH.class, true, false);
079                                  this.add(MSA.class, true, false);
080                                  this.add(ERR.class, false, true);
081                                  this.add(SFT.class, false, false);
082                                  this.add(UAC.class, false, false);
083                                  this.add(RDR_RDR_DEFINITION.class, true, true);
084                                  this.add(DSC.class, false, false);
085               } catch(HL7Exception e) {
086          log.error("Unexpected error creating RDR_RDR - this is probably a bug in the source code generator.", e);
087       }
088    }
089
090
091    /** 
092     * Returns "2.7"
093     */
094    public String getVersion() {
095       return "2.7";
096    }
097
098
099
100
101    /**
102     * <p>
103     * Returns
104     * MSH (Message Header) - creates it if necessary
105     * </p>
106     * 
107     *
108     */
109    public MSH getMSH() { 
110       return getTyped("MSH", MSH.class);
111    }
112
113
114
115
116
117    /**
118     * <p>
119     * Returns
120     * MSA (Message Acknowledgment) - creates it if necessary
121     * </p>
122     * 
123     *
124     */
125    public MSA getMSA() { 
126       return getTyped("MSA", MSA.class);
127    }
128
129
130
131
132
133    /**
134     * <p>
135     * Returns
136     * the first repetition of 
137     * ERR (Error) - creates it if necessary
138     * </p>
139     * 
140     *
141     */
142    public ERR getERR() { 
143       return getTyped("ERR", ERR.class);
144    }
145
146
147    /**
148     * <p>
149     * Returns a specific repetition of
150     * ERR (Error) - creates it if necessary
151     * </p>
152     * 
153     *
154     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
155     * @throws HL7Exception if the repetition requested is more than one 
156     *     greater than the number of existing repetitions.
157     */
158    public ERR getERR(int rep) { 
159       return getTyped("ERR", rep, ERR.class);
160    }
161
162    /** 
163     * <p>
164     * Returns the number of existing repetitions of ERR 
165     * </p>
166     * 
167     */ 
168    public int getERRReps() { 
169        return getReps("ERR");
170    } 
171
172    /** 
173     * <p>
174     * Returns a non-modifiable List containing all current existing repetitions of ERR.
175     * <p>
176     * <p>
177     * Note that unlike {@link #getERR()}, this method will not create any reps
178     * if none are already present, so an empty list may be returned.
179     * </p>
180     * 
181     */ 
182    public java.util.List<ERR> getERRAll() throws HL7Exception {
183        return getAllAsList("ERR", ERR.class);
184    } 
185
186    /**
187     * <p>
188     * Inserts a specific repetition of ERR (Error)
189     * </p>
190     * 
191     *
192     * @see AbstractGroup#insertRepetition(Structure, int) 
193     */
194    public void insertERR(ERR structure, int rep) throws HL7Exception { 
195       super.insertRepetition( "ERR", structure, rep);
196    }
197
198
199    /**
200     * <p>
201     * Inserts a specific repetition of ERR (Error)
202     * </p>
203     * 
204     *
205     * @see AbstractGroup#insertRepetition(Structure, int) 
206     */
207    public ERR insertERR(int rep) throws HL7Exception { 
208       return (ERR)super.insertRepetition("ERR", rep);
209    }
210
211
212    /**
213     * <p>
214     * Removes a specific repetition of ERR (Error)
215     * </p>
216     * 
217     *
218     * @see AbstractGroup#removeRepetition(String, int) 
219     */
220    public ERR removeERR(int rep) throws HL7Exception { 
221       return (ERR)super.removeRepetition("ERR", rep);
222    }
223
224
225
226
227    /**
228     * <p>
229     * Returns
230     * SFT (Software Segment) - creates it if necessary
231     * </p>
232     * 
233     *
234     */
235    public SFT getSFT() { 
236       return getTyped("SFT", SFT.class);
237    }
238
239
240
241
242
243    /**
244     * <p>
245     * Returns
246     * UAC (User Authentication Credential Segment) - creates it if necessary
247     * </p>
248     * 
249     *
250     */
251    public UAC getUAC() { 
252       return getTyped("UAC", UAC.class);
253    }
254
255
256
257
258
259    /**
260     * <p>
261     * Returns
262     * the first repetition of 
263     * DEFINITION (a Group object) - creates it if necessary
264     * </p>
265     * 
266     *
267     */
268    public RDR_RDR_DEFINITION getDEFINITION() { 
269       return getTyped("DEFINITION", RDR_RDR_DEFINITION.class);
270    }
271
272
273    /**
274     * <p>
275     * Returns a specific repetition of
276     * DEFINITION (a Group object) - creates it if necessary
277     * </p>
278     * 
279     *
280     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
281     * @throws HL7Exception if the repetition requested is more than one 
282     *     greater than the number of existing repetitions.
283     */
284    public RDR_RDR_DEFINITION getDEFINITION(int rep) { 
285       return getTyped("DEFINITION", rep, RDR_RDR_DEFINITION.class);
286    }
287
288    /** 
289     * <p>
290     * Returns the number of existing repetitions of DEFINITION 
291     * </p>
292     * 
293     */ 
294    public int getDEFINITIONReps() { 
295        return getReps("DEFINITION");
296    } 
297
298    /** 
299     * <p>
300     * Returns a non-modifiable List containing all current existing repetitions of DEFINITION.
301     * <p>
302     * <p>
303     * Note that unlike {@link #getDEFINITION()}, this method will not create any reps
304     * if none are already present, so an empty list may be returned.
305     * </p>
306     * 
307     */ 
308    public java.util.List<RDR_RDR_DEFINITION> getDEFINITIONAll() throws HL7Exception {
309        return getAllAsList("DEFINITION", RDR_RDR_DEFINITION.class);
310    } 
311
312    /**
313     * <p>
314     * Inserts a specific repetition of DEFINITION (a Group object)
315     * </p>
316     * 
317     *
318     * @see AbstractGroup#insertRepetition(Structure, int) 
319     */
320    public void insertDEFINITION(RDR_RDR_DEFINITION structure, int rep) throws HL7Exception { 
321       super.insertRepetition( "DEFINITION", structure, rep);
322    }
323
324
325    /**
326     * <p>
327     * Inserts a specific repetition of DEFINITION (a Group object)
328     * </p>
329     * 
330     *
331     * @see AbstractGroup#insertRepetition(Structure, int) 
332     */
333    public RDR_RDR_DEFINITION insertDEFINITION(int rep) throws HL7Exception { 
334       return (RDR_RDR_DEFINITION)super.insertRepetition("DEFINITION", rep);
335    }
336
337
338    /**
339     * <p>
340     * Removes a specific repetition of DEFINITION (a Group object)
341     * </p>
342     * 
343     *
344     * @see AbstractGroup#removeRepetition(String, int) 
345     */
346    public RDR_RDR_DEFINITION removeDEFINITION(int rep) throws HL7Exception { 
347       return (RDR_RDR_DEFINITION)super.removeRepetition("DEFINITION", rep);
348    }
349
350
351
352
353    /**
354     * <p>
355     * Returns
356     * DSC (Continuation Pointer) - creates it if necessary
357     * </p>
358     * 
359     *
360     */
361    public DSC getDSC() { 
362       return getTyped("DSC", DSC.class);
363    }
364
365
366
367
368}
369