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