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.v251.group;
035
036import ca.uhn.hl7v2.model.v251.segment.*;
037
038import java.util.List;
039
040import ca.uhn.hl7v2.HL7Exception;
041import ca.uhn.hl7v2.parser.ModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044/**
045 * <p>Represents a RER_RER_DEFINITION group structure (a Group object).
046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together.
047 * This Group contains the following elements:  
048 * </p>
049 * <ul>
050                 * <li>1: QRD (Original-Style Query Definition) <b> </b></li>
051                 * <li>2: QRF (Original style query filter) <b>optional </b></li>
052                 * <li>3: RER_RER_PATIENT (a Group object) <b>optional </b></li>
053                 * <li>4: RER_RER_ORDER (a Group object) <b> repeating</b></li>
054 * </ul>
055 */
056@SuppressWarnings("unused")
057public class RER_RER_DEFINITION extends AbstractGroup {
058
059    /** 
060     * Creates a new RER_RER_DEFINITION group
061     */
062    public RER_RER_DEFINITION(Group parent, ModelClassFactory factory) {
063       super(parent, factory);
064       init(factory);
065    }
066
067    private void init(ModelClassFactory factory) {
068       try {
069                          this.add(QRD.class, true, false);
070                          this.add(QRF.class, false, false);
071                          this.add(RER_RER_PATIENT.class, false, false);
072                          this.add(RER_RER_ORDER.class, true, true);
073       } catch(HL7Exception e) {
074          log.error("Unexpected error creating RER_RER_DEFINITION - this is probably a bug in the source code generator.", e);
075       }
076    }
077
078    /** 
079     * Returns "2.5.1"
080     */
081    public String getVersion() {
082       return "2.5.1";
083    }
084
085
086
087    /**
088     * Returns
089     * QRD (Original-Style Query Definition) - creates it if necessary
090     */
091    public QRD getQRD() { 
092       QRD retVal = getTyped("QRD", QRD.class);
093       return retVal;
094    }
095
096
097
098
099    /**
100     * Returns
101     * QRF (Original style query filter) - creates it if necessary
102     */
103    public QRF getQRF() { 
104       QRF retVal = getTyped("QRF", QRF.class);
105       return retVal;
106    }
107
108
109
110
111    /**
112     * Returns
113     * PATIENT (a Group object) - creates it if necessary
114     */
115    public RER_RER_PATIENT getPATIENT() { 
116       RER_RER_PATIENT retVal = getTyped("PATIENT", RER_RER_PATIENT.class);
117       return retVal;
118    }
119
120
121
122
123    /**
124     * Returns
125     * the first repetition of 
126     * ORDER (a Group object) - creates it if necessary
127     */
128    public RER_RER_ORDER getORDER() { 
129       RER_RER_ORDER retVal = getTyped("ORDER", RER_RER_ORDER.class);
130       return retVal;
131    }
132
133
134    /**
135     * Returns a specific repetition of
136     * ORDER (a Group object) - creates it if necessary
137     *
138     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
139     * @throws HL7Exception if the repetition requested is more than one 
140     *     greater than the number of existing repetitions.
141     */
142    public RER_RER_ORDER getORDER(int rep) { 
143       RER_RER_ORDER retVal = getTyped("ORDER", rep, RER_RER_ORDER.class);
144       return retVal;
145    }
146
147    /** 
148     * Returns the number of existing repetitions of ORDER 
149     */ 
150    public int getORDERReps() {  
151        return getReps("ORDER");
152    } 
153
154    /** 
155     * <p>
156     * Returns a non-modifiable List containing all current existing repetitions of ORDER.
157     * <p>
158     * <p>
159     * Note that unlike {@link #getORDER()}, this method will not create any reps
160     * if none are already present, so an empty list may be returned.
161     * </p>
162     */ 
163    public List<RER_RER_ORDER> getORDERAll() throws HL7Exception {
164        return getAllAsList("ORDER", RER_RER_ORDER.class);
165    } 
166
167    /**
168     * Inserts a specific repetition of ORDER (a Group object)
169     * @see AbstractGroup#insertRepetition(Structure, int) 
170     */
171    public void insertORDER(RER_RER_ORDER structure, int rep) throws HL7Exception { 
172       super.insertRepetition("ORDER", structure, rep);
173    }
174
175
176    /**
177     * Inserts a specific repetition of ORDER (a Group object)
178     * @see AbstractGroup#insertRepetition(Structure, int) 
179     */
180    public RER_RER_ORDER insertORDER(int rep) throws HL7Exception { 
181       return (RER_RER_ORDER)super.insertRepetition("ORDER", rep);
182    }
183
184
185    /**
186     * Removes a specific repetition of ORDER (a Group object)
187     * @see AbstractGroup#removeRepetition(String, int) 
188     */
189    public RER_RER_ORDER removeORDER(int rep) throws HL7Exception { 
190       return (RER_RER_ORDER)super.removeRepetition("ORDER", rep);
191    }
192
193
194
195}
196