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