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.v22.segment;
035
036// import ca.uhn.hl7v2.model.v22.group.*;
037import ca.uhn.hl7v2.model.v22.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047
048/**
049 *<p>Represents an HL7 BTS message segment (BATCH TRAILER). 
050 * This segment has the following fields:</p>
051 * <ul>
052     * <li>BTS-1: Batch Message Count (ST) <b>optional </b>
053     * <li>BTS-2: Batch Comment (ST) <b>optional </b>
054     * <li>BTS-3: Batch Totals (CM_BATCH_TOTAL) <b>optional repeating</b>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class BTS extends AbstractSegment {
059
060    /** 
061     * Creates a new BTS segment
062     */
063    public BTS(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(ST.class, false, 1, 10, new Object[]{ getMessage() }, "Batch Message Count");
071                                  this.add(ST.class, false, 1, 80, new Object[]{ getMessage() }, "Batch Comment");
072                                  this.add(CM_BATCH_TOTAL.class, false, 0, 100, new Object[]{ getMessage() }, "Batch Totals");
073       } catch(HL7Exception e) {
074          log.error("Unexpected error creating BTS - this is probably a bug in the source code generator.", e);
075       }
076    }
077
078
079
080    /**
081     * Returns
082     * BTS-1: "Batch Message Count" - creates it if necessary
083     */
084    public ST getBatchMessageCount() { 
085                ST retVal = this.getTypedField(1, 0);
086                return retVal;
087    }
088    
089    /**
090     * Returns
091     * BTS-1: "Batch Message Count" - creates it if necessary
092     */
093    public ST getBts1_BatchMessageCount() { 
094                ST retVal = this.getTypedField(1, 0);
095                return retVal;
096    }
097
098
099
100    /**
101     * Returns
102     * BTS-2: "Batch Comment" - creates it if necessary
103     */
104    public ST getBatchComment() { 
105                ST retVal = this.getTypedField(2, 0);
106                return retVal;
107    }
108    
109    /**
110     * Returns
111     * BTS-2: "Batch Comment" - creates it if necessary
112     */
113    public ST getBts2_BatchComment() { 
114                ST retVal = this.getTypedField(2, 0);
115                return retVal;
116    }
117
118
119    /**
120     * Returns all repetitions of Batch Totals (BTS-3).
121     */
122    public CM_BATCH_TOTAL[] getBatchTotals() {
123        CM_BATCH_TOTAL[] retVal = this.getTypedField(3, new CM_BATCH_TOTAL[0]);
124        return retVal;
125    }
126
127
128    /**
129     * Returns all repetitions of Batch Totals (BTS-3).
130     */
131    public CM_BATCH_TOTAL[] getBts3_BatchTotals() {
132        CM_BATCH_TOTAL[] retVal = this.getTypedField(3, new CM_BATCH_TOTAL[0]);
133        return retVal;
134    }
135
136
137    /**
138     * Returns a count of the current number of repetitions of Batch Totals (BTS-3).
139     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
140     * it will return zero.
141     */
142    public int getBatchTotalsReps() {
143        return this.getReps(3);
144    }
145
146
147    /**
148     * Returns a specific repetition of
149     * BTS-3: "Batch Totals" - creates it if necessary
150     *
151     * @param rep The repetition index (0-indexed)
152     */
153    public CM_BATCH_TOTAL getBatchTotals(int rep) { 
154                CM_BATCH_TOTAL retVal = this.getTypedField(3, rep);
155                return retVal;
156    }
157
158    /**
159     * Returns a specific repetition of
160     * BTS-3: "Batch Totals" - creates it if necessary
161     *
162     * @param rep The repetition index (0-indexed)
163     */
164    public CM_BATCH_TOTAL getBts3_BatchTotals(int rep) { 
165                CM_BATCH_TOTAL retVal = this.getTypedField(3, rep);
166                return retVal;
167    }
168
169    /**
170     * Returns a count of the current number of repetitions of Batch Totals (BTS-3).
171     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
172     * it will return zero.
173     */
174    public int getBts3_BatchTotalsReps() {
175        return this.getReps(3);
176    }
177
178
179    /**
180     * Inserts a repetition of
181     * BTS-3: "Batch Totals" at a specific index
182     *
183     * @param rep The repetition index (0-indexed)
184     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
185     */
186    public CM_BATCH_TOTAL insertBatchTotals(int rep) throws HL7Exception { 
187        return (CM_BATCH_TOTAL) super.insertRepetition(3, rep);
188    }
189
190
191    /**
192     * Inserts a repetition of
193     * BTS-3: "Batch Totals" at a specific index
194     *
195     * @param rep The repetition index (0-indexed)
196     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
197     */
198    public CM_BATCH_TOTAL insertBts3_BatchTotals(int rep) throws HL7Exception { 
199        return (CM_BATCH_TOTAL) super.insertRepetition(3, rep);
200    }
201
202
203    /**
204     * Removes a repetition of
205     * BTS-3: "Batch Totals" at a specific index
206     *
207     * @param rep The repetition index (0-indexed)
208     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
209     */
210    public CM_BATCH_TOTAL removeBatchTotals(int rep) throws HL7Exception { 
211        return (CM_BATCH_TOTAL) super.removeRepetition(3, rep);
212    }
213
214
215    /**
216     * Removes a repetition of
217     * BTS-3: "Batch Totals" at a specific index
218     *
219     * @param rep The repetition index (0-indexed)
220     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
221     */
222    public CM_BATCH_TOTAL removeBts3_BatchTotals(int rep) throws HL7Exception { 
223        return (CM_BATCH_TOTAL) super.removeRepetition(3, rep);
224    }
225
226
227
228
229
230
231    /** {@inheritDoc} */   
232    protected Type createNewTypeWithoutReflection(int field) {
233       switch (field) {
234          case 0: return new ST(getMessage());
235          case 1: return new ST(getMessage());
236          case 2: return new CM_BATCH_TOTAL(getMessage());
237          default: return null;
238       }
239   }
240
241
242}
243