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.v27.segment;
035
036// import ca.uhn.hl7v2.model.v27.group.*;
037import ca.uhn.hl7v2.model.v27.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 BHS message segment (Batch Header). 
050 * This segment has the following fields:</p>
051 * <ul>
052     * <li>BHS-1: Batch Field Separator (ST) <b> </b>
053     * <li>BHS-2: Batch Encoding Characters (ST) <b> </b>
054     * <li>BHS-3: Batch Sending Application (HD) <b>optional </b>
055     * <li>BHS-4: Batch Sending Facility (HD) <b>optional </b>
056     * <li>BHS-5: Batch Receiving Application (HD) <b>optional </b>
057     * <li>BHS-6: Batch Receiving Facility (HD) <b>optional </b>
058     * <li>BHS-7: Batch Creation Date/Time (DTM) <b>optional </b>
059     * <li>BHS-8: Batch Security (ST) <b>optional </b>
060     * <li>BHS-9: Batch Name/ID/Type (ST) <b>optional </b>
061     * <li>BHS-10: Batch Comment (ST) <b>optional </b>
062     * <li>BHS-11: Batch Control ID (ST) <b>optional </b>
063     * <li>BHS-12: Reference Batch Control ID (ST) <b>optional </b>
064     * <li>BHS-13: Batch Sending Network Address (HD) <b>optional </b>
065     * <li>BHS-14: Batch Receiving Network Address (HD) <b>optional </b>
066 * </ul>
067 */
068@SuppressWarnings("unused")
069public class BHS extends AbstractSegment {
070
071    /** 
072     * Creates a new BHS segment
073     */
074    public BHS(Group parent, ModelClassFactory factory) {
075       super(parent, factory);
076       init(factory);
077    }
078
079    private void init(ModelClassFactory factory) {
080       try {
081                                  this.add(ST.class, true, 1, 1, new Object[]{ getMessage() }, "Batch Field Separator");
082                                  this.add(ST.class, true, 1, 5, new Object[]{ getMessage() }, "Batch Encoding Characters");
083                                  this.add(HD.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Sending Application");
084                                  this.add(HD.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Sending Facility");
085                                  this.add(HD.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Receiving Application");
086                                  this.add(HD.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Receiving Facility");
087                                  this.add(DTM.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Creation Date/Time");
088                                  this.add(ST.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Security");
089                                  this.add(ST.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Name/ID/Type");
090                                  this.add(ST.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Comment");
091                                  this.add(ST.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Control ID");
092                                  this.add(ST.class, false, 1, 0, new Object[]{ getMessage() }, "Reference Batch Control ID");
093                                  this.add(HD.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Sending Network Address");
094                                  this.add(HD.class, false, 1, 0, new Object[]{ getMessage() }, "Batch Receiving Network Address");
095       } catch(HL7Exception e) {
096          log.error("Unexpected error creating BHS - this is probably a bug in the source code generator.", e);
097       }
098    }
099
100
101
102    /**
103     * Returns
104     * BHS-1: "Batch Field Separator" - creates it if necessary
105     */
106    public ST getBatchFieldSeparator() { 
107                ST retVal = this.getTypedField(1, 0);
108                return retVal;
109    }
110    
111    /**
112     * Returns
113     * BHS-1: "Batch Field Separator" - creates it if necessary
114     */
115    public ST getBhs1_BatchFieldSeparator() { 
116                ST retVal = this.getTypedField(1, 0);
117                return retVal;
118    }
119
120
121
122    /**
123     * Returns
124     * BHS-2: "Batch Encoding Characters" - creates it if necessary
125     */
126    public ST getBatchEncodingCharacters() { 
127                ST retVal = this.getTypedField(2, 0);
128                return retVal;
129    }
130    
131    /**
132     * Returns
133     * BHS-2: "Batch Encoding Characters" - creates it if necessary
134     */
135    public ST getBhs2_BatchEncodingCharacters() { 
136                ST retVal = this.getTypedField(2, 0);
137                return retVal;
138    }
139
140
141
142    /**
143     * Returns
144     * BHS-3: "Batch Sending Application" - creates it if necessary
145     */
146    public HD getBatchSendingApplication() { 
147                HD retVal = this.getTypedField(3, 0);
148                return retVal;
149    }
150    
151    /**
152     * Returns
153     * BHS-3: "Batch Sending Application" - creates it if necessary
154     */
155    public HD getBhs3_BatchSendingApplication() { 
156                HD retVal = this.getTypedField(3, 0);
157                return retVal;
158    }
159
160
161
162    /**
163     * Returns
164     * BHS-4: "Batch Sending Facility" - creates it if necessary
165     */
166    public HD getBatchSendingFacility() { 
167                HD retVal = this.getTypedField(4, 0);
168                return retVal;
169    }
170    
171    /**
172     * Returns
173     * BHS-4: "Batch Sending Facility" - creates it if necessary
174     */
175    public HD getBhs4_BatchSendingFacility() { 
176                HD retVal = this.getTypedField(4, 0);
177                return retVal;
178    }
179
180
181
182    /**
183     * Returns
184     * BHS-5: "Batch Receiving Application" - creates it if necessary
185     */
186    public HD getBatchReceivingApplication() { 
187                HD retVal = this.getTypedField(5, 0);
188                return retVal;
189    }
190    
191    /**
192     * Returns
193     * BHS-5: "Batch Receiving Application" - creates it if necessary
194     */
195    public HD getBhs5_BatchReceivingApplication() { 
196                HD retVal = this.getTypedField(5, 0);
197                return retVal;
198    }
199
200
201
202    /**
203     * Returns
204     * BHS-6: "Batch Receiving Facility" - creates it if necessary
205     */
206    public HD getBatchReceivingFacility() { 
207                HD retVal = this.getTypedField(6, 0);
208                return retVal;
209    }
210    
211    /**
212     * Returns
213     * BHS-6: "Batch Receiving Facility" - creates it if necessary
214     */
215    public HD getBhs6_BatchReceivingFacility() { 
216                HD retVal = this.getTypedField(6, 0);
217                return retVal;
218    }
219
220
221
222    /**
223     * Returns
224     * BHS-7: "Batch Creation Date/Time" - creates it if necessary
225     */
226    public DTM getBatchCreationDateTime() { 
227                DTM retVal = this.getTypedField(7, 0);
228                return retVal;
229    }
230    
231    /**
232     * Returns
233     * BHS-7: "Batch Creation Date/Time" - creates it if necessary
234     */
235    public DTM getBhs7_BatchCreationDateTime() { 
236                DTM retVal = this.getTypedField(7, 0);
237                return retVal;
238    }
239
240
241
242    /**
243     * Returns
244     * BHS-8: "Batch Security" - creates it if necessary
245     */
246    public ST getBatchSecurity() { 
247                ST retVal = this.getTypedField(8, 0);
248                return retVal;
249    }
250    
251    /**
252     * Returns
253     * BHS-8: "Batch Security" - creates it if necessary
254     */
255    public ST getBhs8_BatchSecurity() { 
256                ST retVal = this.getTypedField(8, 0);
257                return retVal;
258    }
259
260
261
262    /**
263     * Returns
264     * BHS-9: "Batch Name/ID/Type" - creates it if necessary
265     */
266    public ST getBatchNameIDType() { 
267                ST retVal = this.getTypedField(9, 0);
268                return retVal;
269    }
270    
271    /**
272     * Returns
273     * BHS-9: "Batch Name/ID/Type" - creates it if necessary
274     */
275    public ST getBhs9_BatchNameIDType() { 
276                ST retVal = this.getTypedField(9, 0);
277                return retVal;
278    }
279
280
281
282    /**
283     * Returns
284     * BHS-10: "Batch Comment" - creates it if necessary
285     */
286    public ST getBatchComment() { 
287                ST retVal = this.getTypedField(10, 0);
288                return retVal;
289    }
290    
291    /**
292     * Returns
293     * BHS-10: "Batch Comment" - creates it if necessary
294     */
295    public ST getBhs10_BatchComment() { 
296                ST retVal = this.getTypedField(10, 0);
297                return retVal;
298    }
299
300
301
302    /**
303     * Returns
304     * BHS-11: "Batch Control ID" - creates it if necessary
305     */
306    public ST getBatchControlID() { 
307                ST retVal = this.getTypedField(11, 0);
308                return retVal;
309    }
310    
311    /**
312     * Returns
313     * BHS-11: "Batch Control ID" - creates it if necessary
314     */
315    public ST getBhs11_BatchControlID() { 
316                ST retVal = this.getTypedField(11, 0);
317                return retVal;
318    }
319
320
321
322    /**
323     * Returns
324     * BHS-12: "Reference Batch Control ID" - creates it if necessary
325     */
326    public ST getReferenceBatchControlID() { 
327                ST retVal = this.getTypedField(12, 0);
328                return retVal;
329    }
330    
331    /**
332     * Returns
333     * BHS-12: "Reference Batch Control ID" - creates it if necessary
334     */
335    public ST getBhs12_ReferenceBatchControlID() { 
336                ST retVal = this.getTypedField(12, 0);
337                return retVal;
338    }
339
340
341
342    /**
343     * Returns
344     * BHS-13: "Batch Sending Network Address" - creates it if necessary
345     */
346    public HD getBatchSendingNetworkAddress() { 
347                HD retVal = this.getTypedField(13, 0);
348                return retVal;
349    }
350    
351    /**
352     * Returns
353     * BHS-13: "Batch Sending Network Address" - creates it if necessary
354     */
355    public HD getBhs13_BatchSendingNetworkAddress() { 
356                HD retVal = this.getTypedField(13, 0);
357                return retVal;
358    }
359
360
361
362    /**
363     * Returns
364     * BHS-14: "Batch Receiving Network Address" - creates it if necessary
365     */
366    public HD getBatchReceivingNetworkAddress() { 
367                HD retVal = this.getTypedField(14, 0);
368                return retVal;
369    }
370    
371    /**
372     * Returns
373     * BHS-14: "Batch Receiving Network Address" - creates it if necessary
374     */
375    public HD getBhs14_BatchReceivingNetworkAddress() { 
376                HD retVal = this.getTypedField(14, 0);
377                return retVal;
378    }
379
380
381
382
383
384    /** {@inheritDoc} */   
385    protected Type createNewTypeWithoutReflection(int field) {
386       switch (field) {
387          case 0: return new ST(getMessage());
388          case 1: return new ST(getMessage());
389          case 2: return new HD(getMessage());
390          case 3: return new HD(getMessage());
391          case 4: return new HD(getMessage());
392          case 5: return new HD(getMessage());
393          case 6: return new DTM(getMessage());
394          case 7: return new ST(getMessage());
395          case 8: return new ST(getMessage());
396          case 9: return new ST(getMessage());
397          case 10: return new ST(getMessage());
398          case 11: return new ST(getMessage());
399          case 12: return new HD(getMessage());
400          case 13: return new HD(getMessage());
401          default: return null;
402       }
403   }
404
405
406}
407