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.v26.message; 035 036import ca.uhn.hl7v2.model.v26.group.*; 037import ca.uhn.hl7v2.model.v26.segment.*; 038 039import java.util.List; 040 041import ca.uhn.hl7v2.HL7Exception; 042import ca.uhn.hl7v2.parser.ModelClassFactory; 043import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 044import ca.uhn.hl7v2.model.AbstractMessage; 045 046/** 047 * <p>Represents a EHC_E10 message structure (see chapter 16.3.6). This structure contains the 048 * following elements: </p> 049 * <ul> 050 * <li>1: MSH (Message Header) <b> </b></li> 051 * <li>2: SFT (Software Segment) <b>optional repeating</b></li> 052 * <li>3: UAC (User Authentication Credential Segment) <b>optional repeating</b></li> 053 * <li>4: MSA (Message Acknowledgment) <b> </b></li> 054 * <li>5: ERR (Error) <b>optional repeating</b></li> 055 * <li>6: EHC_E10_INVOICE_PROCESSING_RESULTS_INFO (a Group object) <b> repeating</b></li> 056 * </ul> 057 */ 058@SuppressWarnings("unused") 059public class EHC_E10 extends AbstractMessage { 060 061 /** 062 * Creates a new EHC_E10 message with DefaultModelClassFactory. 063 */ 064 public EHC_E10() { 065 this(new DefaultModelClassFactory()); 066 } 067 068 /** 069 * Creates a new EHC_E10 message with custom ModelClassFactory. 070 */ 071 public EHC_E10(ModelClassFactory factory) { 072 super(factory); 073 init(factory); 074 } 075 076 private void init(ModelClassFactory factory) { 077 try { 078 this.add(MSH.class, true, false); 079 this.add(SFT.class, false, true); 080 this.add(UAC.class, false, true); 081 this.add(MSA.class, true, false); 082 this.add(ERR.class, false, true); 083 this.add(EHC_E10_INVOICE_PROCESSING_RESULTS_INFO.class, true, true); 084 } catch(HL7Exception e) { 085 log.error("Unexpected error creating EHC_E10 - this is probably a bug in the source code generator.", e); 086 } 087 } 088 089 /** 090 * Returns "2.6" 091 */ 092 public String getVersion() { 093 return "2.6"; 094 } 095 096 097 098 /** 099 * Returns 100 * MSH (Message Header) - creates it if necessary 101 */ 102 public MSH getMSH() { 103 return getTyped("MSH", MSH.class); 104 } 105 106 107 108 109 /** 110 * Returns 111 * the first repetition of 112 * SFT (Software Segment) - creates it if necessary 113 */ 114 public SFT getSFT() { 115 return getTyped("SFT", SFT.class); 116 } 117 118 119 /** 120 * Returns a specific repetition of 121 * SFT (Software Segment) - creates it if necessary 122 * 123 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 124 * @throws HL7Exception if the repetition requested is more than one 125 * greater than the number of existing repetitions. 126 */ 127 public SFT getSFT(int rep) { 128 return getTyped("SFT", rep, SFT.class); 129 } 130 131 /** 132 * Returns the number of existing repetitions of SFT 133 */ 134 public int getSFTReps() { 135 return getReps("SFT"); 136 } 137 138 /** 139 * <p> 140 * Returns a non-modifiable List containing all current existing repetitions of SFT. 141 * <p> 142 * <p> 143 * Note that unlike {@link #getSFT()}, this method will not create any reps 144 * if none are already present, so an empty list may be returned. 145 * </p> 146 */ 147 public List<SFT> getSFTAll() throws HL7Exception { 148 return getAllAsList("SFT", SFT.class); 149 } 150 151 /** 152 * Inserts a specific repetition of SFT (Software Segment) 153 * @see AbstractGroup#insertRepetition(Structure, int) 154 */ 155 public void insertSFT(SFT structure, int rep) throws HL7Exception { 156 super.insertRepetition( "SFT", structure, rep); 157 } 158 159 160 /** 161 * Inserts a specific repetition of SFT (Software Segment) 162 * @see AbstractGroup#insertRepetition(Structure, int) 163 */ 164 public SFT insertSFT(int rep) throws HL7Exception { 165 return (SFT)super.insertRepetition("SFT", rep); 166 } 167 168 169 /** 170 * Removes a specific repetition of SFT (Software Segment) 171 * @see AbstractGroup#removeRepetition(String, int) 172 */ 173 public SFT removeSFT(int rep) throws HL7Exception { 174 return (SFT)super.removeRepetition("SFT", rep); 175 } 176 177 178 179 /** 180 * Returns 181 * the first repetition of 182 * UAC (User Authentication Credential Segment) - creates it if necessary 183 */ 184 public UAC getUAC() { 185 return getTyped("UAC", UAC.class); 186 } 187 188 189 /** 190 * Returns a specific repetition of 191 * UAC (User Authentication Credential Segment) - creates it if necessary 192 * 193 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 194 * @throws HL7Exception if the repetition requested is more than one 195 * greater than the number of existing repetitions. 196 */ 197 public UAC getUAC(int rep) { 198 return getTyped("UAC", rep, UAC.class); 199 } 200 201 /** 202 * Returns the number of existing repetitions of UAC 203 */ 204 public int getUACReps() { 205 return getReps("UAC"); 206 } 207 208 /** 209 * <p> 210 * Returns a non-modifiable List containing all current existing repetitions of UAC. 211 * <p> 212 * <p> 213 * Note that unlike {@link #getUAC()}, this method will not create any reps 214 * if none are already present, so an empty list may be returned. 215 * </p> 216 */ 217 public List<UAC> getUACAll() throws HL7Exception { 218 return getAllAsList("UAC", UAC.class); 219 } 220 221 /** 222 * Inserts a specific repetition of UAC (User Authentication Credential Segment) 223 * @see AbstractGroup#insertRepetition(Structure, int) 224 */ 225 public void insertUAC(UAC structure, int rep) throws HL7Exception { 226 super.insertRepetition( "UAC", structure, rep); 227 } 228 229 230 /** 231 * Inserts a specific repetition of UAC (User Authentication Credential Segment) 232 * @see AbstractGroup#insertRepetition(Structure, int) 233 */ 234 public UAC insertUAC(int rep) throws HL7Exception { 235 return (UAC)super.insertRepetition("UAC", rep); 236 } 237 238 239 /** 240 * Removes a specific repetition of UAC (User Authentication Credential Segment) 241 * @see AbstractGroup#removeRepetition(String, int) 242 */ 243 public UAC removeUAC(int rep) throws HL7Exception { 244 return (UAC)super.removeRepetition("UAC", rep); 245 } 246 247 248 249 /** 250 * Returns 251 * MSA (Message Acknowledgment) - creates it if necessary 252 */ 253 public MSA getMSA() { 254 return getTyped("MSA", MSA.class); 255 } 256 257 258 259 260 /** 261 * Returns 262 * the first repetition of 263 * ERR (Error) - creates it if necessary 264 */ 265 public ERR getERR() { 266 return getTyped("ERR", ERR.class); 267 } 268 269 270 /** 271 * Returns a specific repetition of 272 * ERR (Error) - creates it if necessary 273 * 274 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 275 * @throws HL7Exception if the repetition requested is more than one 276 * greater than the number of existing repetitions. 277 */ 278 public ERR getERR(int rep) { 279 return getTyped("ERR", rep, ERR.class); 280 } 281 282 /** 283 * Returns the number of existing repetitions of ERR 284 */ 285 public int getERRReps() { 286 return getReps("ERR"); 287 } 288 289 /** 290 * <p> 291 * Returns a non-modifiable List containing all current existing repetitions of ERR. 292 * <p> 293 * <p> 294 * Note that unlike {@link #getERR()}, this method will not create any reps 295 * if none are already present, so an empty list may be returned. 296 * </p> 297 */ 298 public List<ERR> getERRAll() throws HL7Exception { 299 return getAllAsList("ERR", ERR.class); 300 } 301 302 /** 303 * Inserts a specific repetition of ERR (Error) 304 * @see AbstractGroup#insertRepetition(Structure, int) 305 */ 306 public void insertERR(ERR structure, int rep) throws HL7Exception { 307 super.insertRepetition( "ERR", structure, rep); 308 } 309 310 311 /** 312 * Inserts a specific repetition of ERR (Error) 313 * @see AbstractGroup#insertRepetition(Structure, int) 314 */ 315 public ERR insertERR(int rep) throws HL7Exception { 316 return (ERR)super.insertRepetition("ERR", rep); 317 } 318 319 320 /** 321 * Removes a specific repetition of ERR (Error) 322 * @see AbstractGroup#removeRepetition(String, int) 323 */ 324 public ERR removeERR(int rep) throws HL7Exception { 325 return (ERR)super.removeRepetition("ERR", rep); 326 } 327 328 329 330 /** 331 * Returns 332 * the first repetition of 333 * INVOICE_PROCESSING_RESULTS_INFO (a Group object) - creates it if necessary 334 */ 335 public EHC_E10_INVOICE_PROCESSING_RESULTS_INFO getINVOICE_PROCESSING_RESULTS_INFO() { 336 return getTyped("INVOICE_PROCESSING_RESULTS_INFO", EHC_E10_INVOICE_PROCESSING_RESULTS_INFO.class); 337 } 338 339 340 /** 341 * Returns a specific repetition of 342 * INVOICE_PROCESSING_RESULTS_INFO (a Group object) - creates it if necessary 343 * 344 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 345 * @throws HL7Exception if the repetition requested is more than one 346 * greater than the number of existing repetitions. 347 */ 348 public EHC_E10_INVOICE_PROCESSING_RESULTS_INFO getINVOICE_PROCESSING_RESULTS_INFO(int rep) { 349 return getTyped("INVOICE_PROCESSING_RESULTS_INFO", rep, EHC_E10_INVOICE_PROCESSING_RESULTS_INFO.class); 350 } 351 352 /** 353 * Returns the number of existing repetitions of INVOICE_PROCESSING_RESULTS_INFO 354 */ 355 public int getINVOICE_PROCESSING_RESULTS_INFOReps() { 356 return getReps("INVOICE_PROCESSING_RESULTS_INFO"); 357 } 358 359 /** 360 * <p> 361 * Returns a non-modifiable List containing all current existing repetitions of INVOICE_PROCESSING_RESULTS_INFO. 362 * <p> 363 * <p> 364 * Note that unlike {@link #getINVOICE_PROCESSING_RESULTS_INFO()}, this method will not create any reps 365 * if none are already present, so an empty list may be returned. 366 * </p> 367 */ 368 public List<EHC_E10_INVOICE_PROCESSING_RESULTS_INFO> getINVOICE_PROCESSING_RESULTS_INFOAll() throws HL7Exception { 369 return getAllAsList("INVOICE_PROCESSING_RESULTS_INFO", EHC_E10_INVOICE_PROCESSING_RESULTS_INFO.class); 370 } 371 372 /** 373 * Inserts a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object) 374 * @see AbstractGroup#insertRepetition(Structure, int) 375 */ 376 public void insertINVOICE_PROCESSING_RESULTS_INFO(EHC_E10_INVOICE_PROCESSING_RESULTS_INFO structure, int rep) throws HL7Exception { 377 super.insertRepetition( "INVOICE_PROCESSING_RESULTS_INFO", structure, rep); 378 } 379 380 381 /** 382 * Inserts a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object) 383 * @see AbstractGroup#insertRepetition(Structure, int) 384 */ 385 public EHC_E10_INVOICE_PROCESSING_RESULTS_INFO insertINVOICE_PROCESSING_RESULTS_INFO(int rep) throws HL7Exception { 386 return (EHC_E10_INVOICE_PROCESSING_RESULTS_INFO)super.insertRepetition("INVOICE_PROCESSING_RESULTS_INFO", rep); 387 } 388 389 390 /** 391 * Removes a specific repetition of INVOICE_PROCESSING_RESULTS_INFO (a Group object) 392 * @see AbstractGroup#removeRepetition(String, int) 393 */ 394 public EHC_E10_INVOICE_PROCESSING_RESULTS_INFO removeINVOICE_PROCESSING_RESULTS_INFO(int rep) throws HL7Exception { 395 return (EHC_E10_INVOICE_PROCESSING_RESULTS_INFO)super.removeRepetition("INVOICE_PROCESSING_RESULTS_INFO", rep); 396 } 397 398 399 400} 401