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 ca.uhn.hl7v2.HL7Exception; 040import ca.uhn.hl7v2.parser.ModelClassFactory; 041import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044 045/** 046 * <p>Represents a ORF_R04 message structure (see chapter 7.3.3). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message Header) <b> </b> </li> 050 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li> 051 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b> </li> 052 * <li>4: MSA (Message Acknowledgment) <b> </b> </li> 053 * <li>5: QRD (Original-Style Query Definition) <b> </b> </li> 054 * <li>6: QRF (Original style query filter) <b>optional </b> </li> 055 * <li>7: ORF_R04_QUERY_RESPONSE (a Group object) <b> repeating</b> </li> 056 * <li>8: ERR (Error) <b>optional repeating</b> </li> 057 * <li>9: QAK (Query Acknowledgment) <b>optional </b> </li> 058 * <li>10: DSC (Continuation Pointer) <b>optional </b> </li> 059 * </ul> 060 */ 061//@SuppressWarnings("unused") 062public class ORF_R04 extends AbstractMessage { 063 064 /** 065 * Creates a new ORF_R04 message with DefaultModelClassFactory. 066 */ 067 public ORF_R04() { 068 this(new DefaultModelClassFactory()); 069 } 070 071 /** 072 * Creates a new ORF_R04 message with custom ModelClassFactory. 073 */ 074 public ORF_R04(ModelClassFactory factory) { 075 super(factory); 076 init(factory); 077 } 078 079 private void init(ModelClassFactory factory) { 080 try { 081 this.add(MSH.class, true, false); 082 this.add(SFT.class, false, true); 083 this.add(UAC.class, false, false); 084 this.add(MSA.class, true, false); 085 this.add(QRD.class, true, false); 086 this.add(QRF.class, false, false); 087 this.add(ORF_R04_QUERY_RESPONSE.class, true, true); 088 this.add(ERR.class, false, true); 089 this.add(QAK.class, false, false); 090 this.add(DSC.class, false, false); 091 } catch(HL7Exception e) { 092 log.error("Unexpected error creating ORF_R04 - this is probably a bug in the source code generator.", e); 093 } 094 } 095 096 097 /** 098 * Returns "2.6" 099 */ 100 public String getVersion() { 101 return "2.6"; 102 } 103 104 105 106 107 /** 108 * <p> 109 * Returns 110 * MSH (Message Header) - creates it if necessary 111 * </p> 112 * 113 * 114 */ 115 public MSH getMSH() { 116 return getTyped("MSH", MSH.class); 117 } 118 119 120 121 122 123 /** 124 * <p> 125 * Returns 126 * the first repetition of 127 * SFT (Software Segment) - creates it if necessary 128 * </p> 129 * 130 * 131 */ 132 public SFT getSFT() { 133 return getTyped("SFT", SFT.class); 134 } 135 136 137 /** 138 * <p> 139 * Returns a specific repetition of 140 * SFT (Software Segment) - creates it if necessary 141 * </p> 142 * 143 * 144 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 145 * @throws HL7Exception if the repetition requested is more than one 146 * greater than the number of existing repetitions. 147 */ 148 public SFT getSFT(int rep) { 149 return getTyped("SFT", rep, SFT.class); 150 } 151 152 /** 153 * <p> 154 * Returns the number of existing repetitions of SFT 155 * </p> 156 * 157 */ 158 public int getSFTReps() { 159 return getReps("SFT"); 160 } 161 162 /** 163 * <p> 164 * Returns a non-modifiable List containing all current existing repetitions of SFT. 165 * <p> 166 * <p> 167 * Note that unlike {@link #getSFT()}, this method will not create any reps 168 * if none are already present, so an empty list may be returned. 169 * </p> 170 * 171 */ 172 public java.util.List<SFT> getSFTAll() throws HL7Exception { 173 return getAllAsList("SFT", SFT.class); 174 } 175 176 /** 177 * <p> 178 * Inserts a specific repetition of SFT (Software Segment) 179 * </p> 180 * 181 * 182 * @see AbstractGroup#insertRepetition(Structure, int) 183 */ 184 public void insertSFT(SFT structure, int rep) throws HL7Exception { 185 super.insertRepetition( "SFT", structure, rep); 186 } 187 188 189 /** 190 * <p> 191 * Inserts a specific repetition of SFT (Software Segment) 192 * </p> 193 * 194 * 195 * @see AbstractGroup#insertRepetition(Structure, int) 196 */ 197 public SFT insertSFT(int rep) throws HL7Exception { 198 return (SFT)super.insertRepetition("SFT", rep); 199 } 200 201 202 /** 203 * <p> 204 * Removes a specific repetition of SFT (Software Segment) 205 * </p> 206 * 207 * 208 * @see AbstractGroup#removeRepetition(String, int) 209 */ 210 public SFT removeSFT(int rep) throws HL7Exception { 211 return (SFT)super.removeRepetition("SFT", rep); 212 } 213 214 215 216 217 /** 218 * <p> 219 * Returns 220 * UAC (User Authentication Credential Segment) - creates it if necessary 221 * </p> 222 * 223 * 224 */ 225 public UAC getUAC() { 226 return getTyped("UAC", UAC.class); 227 } 228 229 230 231 232 233 /** 234 * <p> 235 * Returns 236 * MSA (Message Acknowledgment) - creates it if necessary 237 * </p> 238 * 239 * 240 */ 241 public MSA getMSA() { 242 return getTyped("MSA", MSA.class); 243 } 244 245 246 247 248 249 /** 250 * <p> 251 * Returns 252 * QRD (Original-Style Query Definition) - creates it if necessary 253 * </p> 254 * 255 * 256 */ 257 public QRD getQRD() { 258 return getTyped("QRD", QRD.class); 259 } 260 261 262 263 264 265 /** 266 * <p> 267 * Returns 268 * QRF (Original style query filter) - creates it if necessary 269 * </p> 270 * 271 * 272 */ 273 public QRF getQRF() { 274 return getTyped("QRF", QRF.class); 275 } 276 277 278 279 280 281 /** 282 * <p> 283 * Returns 284 * the first repetition of 285 * QUERY_RESPONSE (a Group object) - creates it if necessary 286 * </p> 287 * 288 * 289 */ 290 public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE() { 291 return getTyped("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class); 292 } 293 294 295 /** 296 * <p> 297 * Returns a specific repetition of 298 * QUERY_RESPONSE (a Group object) - creates it if necessary 299 * </p> 300 * 301 * 302 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 303 * @throws HL7Exception if the repetition requested is more than one 304 * greater than the number of existing repetitions. 305 */ 306 public ORF_R04_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 307 return getTyped("QUERY_RESPONSE", rep, ORF_R04_QUERY_RESPONSE.class); 308 } 309 310 /** 311 * <p> 312 * Returns the number of existing repetitions of QUERY_RESPONSE 313 * </p> 314 * 315 */ 316 public int getQUERY_RESPONSEReps() { 317 return getReps("QUERY_RESPONSE"); 318 } 319 320 /** 321 * <p> 322 * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE. 323 * <p> 324 * <p> 325 * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps 326 * if none are already present, so an empty list may be returned. 327 * </p> 328 * 329 */ 330 public java.util.List<ORF_R04_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception { 331 return getAllAsList("QUERY_RESPONSE", ORF_R04_QUERY_RESPONSE.class); 332 } 333 334 /** 335 * <p> 336 * Inserts a specific repetition of QUERY_RESPONSE (a Group object) 337 * </p> 338 * 339 * 340 * @see AbstractGroup#insertRepetition(Structure, int) 341 */ 342 public void insertQUERY_RESPONSE(ORF_R04_QUERY_RESPONSE structure, int rep) throws HL7Exception { 343 super.insertRepetition( "QUERY_RESPONSE", structure, rep); 344 } 345 346 347 /** 348 * <p> 349 * Inserts a specific repetition of QUERY_RESPONSE (a Group object) 350 * </p> 351 * 352 * 353 * @see AbstractGroup#insertRepetition(Structure, int) 354 */ 355 public ORF_R04_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 356 return (ORF_R04_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep); 357 } 358 359 360 /** 361 * <p> 362 * Removes a specific repetition of QUERY_RESPONSE (a Group object) 363 * </p> 364 * 365 * 366 * @see AbstractGroup#removeRepetition(String, int) 367 */ 368 public ORF_R04_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 369 return (ORF_R04_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep); 370 } 371 372 373 374 375 /** 376 * <p> 377 * Returns 378 * the first repetition of 379 * ERR (Error) - creates it if necessary 380 * </p> 381 * 382 * 383 */ 384 public ERR getERR() { 385 return getTyped("ERR", ERR.class); 386 } 387 388 389 /** 390 * <p> 391 * Returns a specific repetition of 392 * ERR (Error) - creates it if necessary 393 * </p> 394 * 395 * 396 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 397 * @throws HL7Exception if the repetition requested is more than one 398 * greater than the number of existing repetitions. 399 */ 400 public ERR getERR(int rep) { 401 return getTyped("ERR", rep, ERR.class); 402 } 403 404 /** 405 * <p> 406 * Returns the number of existing repetitions of ERR 407 * </p> 408 * 409 */ 410 public int getERRReps() { 411 return getReps("ERR"); 412 } 413 414 /** 415 * <p> 416 * Returns a non-modifiable List containing all current existing repetitions of ERR. 417 * <p> 418 * <p> 419 * Note that unlike {@link #getERR()}, this method will not create any reps 420 * if none are already present, so an empty list may be returned. 421 * </p> 422 * 423 */ 424 public java.util.List<ERR> getERRAll() throws HL7Exception { 425 return getAllAsList("ERR", ERR.class); 426 } 427 428 /** 429 * <p> 430 * Inserts a specific repetition of ERR (Error) 431 * </p> 432 * 433 * 434 * @see AbstractGroup#insertRepetition(Structure, int) 435 */ 436 public void insertERR(ERR structure, int rep) throws HL7Exception { 437 super.insertRepetition( "ERR", structure, rep); 438 } 439 440 441 /** 442 * <p> 443 * Inserts a specific repetition of ERR (Error) 444 * </p> 445 * 446 * 447 * @see AbstractGroup#insertRepetition(Structure, int) 448 */ 449 public ERR insertERR(int rep) throws HL7Exception { 450 return (ERR)super.insertRepetition("ERR", rep); 451 } 452 453 454 /** 455 * <p> 456 * Removes a specific repetition of ERR (Error) 457 * </p> 458 * 459 * 460 * @see AbstractGroup#removeRepetition(String, int) 461 */ 462 public ERR removeERR(int rep) throws HL7Exception { 463 return (ERR)super.removeRepetition("ERR", rep); 464 } 465 466 467 468 469 /** 470 * <p> 471 * Returns 472 * QAK (Query Acknowledgment) - creates it if necessary 473 * </p> 474 * 475 * 476 */ 477 public QAK getQAK() { 478 return getTyped("QAK", QAK.class); 479 } 480 481 482 483 484 485 /** 486 * <p> 487 * Returns 488 * DSC (Continuation Pointer) - creates it if necessary 489 * </p> 490 * 491 * 492 */ 493 public DSC getDSC() { 494 return getTyped("DSC", DSC.class); 495 } 496 497 498 499 500} 501