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