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