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.v25.group;
035
036import ca.uhn.hl7v2.model.v25.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 RRA_O18_ADMINISTRATION 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: RXA (Pharmacy/Treatment Administration) <b> repeating</b></li>
051                 * <li>2: RXR (Pharmacy/Treatment Route) <b> </b></li>
052 * </ul>
053 */
054@SuppressWarnings("unused")
055public class RRA_O18_ADMINISTRATION extends AbstractGroup {
056
057    /** 
058     * Creates a new RRA_O18_ADMINISTRATION group
059     */
060    public RRA_O18_ADMINISTRATION(Group parent, ModelClassFactory factory) {
061       super(parent, factory);
062       init(factory);
063    }
064
065    private void init(ModelClassFactory factory) {
066       try {
067                          this.add(RXA.class, true, true);
068                          this.add(RXR.class, true, false);
069       } catch(HL7Exception e) {
070          log.error("Unexpected error creating RRA_O18_ADMINISTRATION - this is probably a bug in the source code generator.", e);
071       }
072    }
073
074    /** 
075     * Returns "2.5"
076     */
077    public String getVersion() {
078       return "2.5";
079    }
080
081
082
083    /**
084     * Returns
085     * the first repetition of 
086     * RXA (Pharmacy/Treatment Administration) - creates it if necessary
087     */
088    public RXA getRXA() { 
089       RXA retVal = getTyped("RXA", RXA.class);
090       return retVal;
091    }
092
093
094    /**
095     * Returns a specific repetition of
096     * RXA (Pharmacy/Treatment Administration) - creates it if necessary
097     *
098     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
099     * @throws HL7Exception if the repetition requested is more than one 
100     *     greater than the number of existing repetitions.
101     */
102    public RXA getRXA(int rep) { 
103       RXA retVal = getTyped("RXA", rep, RXA.class);
104       return retVal;
105    }
106
107    /** 
108     * Returns the number of existing repetitions of RXA 
109     */ 
110    public int getRXAReps() {  
111        return getReps("RXA");
112    } 
113
114    /** 
115     * <p>
116     * Returns a non-modifiable List containing all current existing repetitions of RXA.
117     * <p>
118     * <p>
119     * Note that unlike {@link #getRXA()}, this method will not create any reps
120     * if none are already present, so an empty list may be returned.
121     * </p>
122     */ 
123    public List<RXA> getRXAAll() throws HL7Exception {
124        return getAllAsList("RXA", RXA.class);
125    } 
126
127    /**
128     * Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
129     * @see AbstractGroup#insertRepetition(Structure, int) 
130     */
131    public void insertRXA(RXA structure, int rep) throws HL7Exception { 
132       super.insertRepetition("RXA", structure, rep);
133    }
134
135
136    /**
137     * Inserts a specific repetition of RXA (Pharmacy/Treatment Administration)
138     * @see AbstractGroup#insertRepetition(Structure, int) 
139     */
140    public RXA insertRXA(int rep) throws HL7Exception { 
141       return (RXA)super.insertRepetition("RXA", rep);
142    }
143
144
145    /**
146     * Removes a specific repetition of RXA (Pharmacy/Treatment Administration)
147     * @see AbstractGroup#removeRepetition(String, int) 
148     */
149    public RXA removeRXA(int rep) throws HL7Exception { 
150       return (RXA)super.removeRepetition("RXA", rep);
151    }
152
153
154
155    /**
156     * Returns
157     * RXR (Pharmacy/Treatment Route) - creates it if necessary
158     */
159    public RXR getRXR() { 
160       RXR retVal = getTyped("RXR", RXR.class);
161       return retVal;
162    }
163
164
165
166
167}
168