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