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.message; 035 036import ca.uhn.hl7v2.model.v27.group.*; 037import ca.uhn.hl7v2.model.v27.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 RSP_K25 message structure (see chapter 15.3.7). 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: ERR (Error) <b>optional repeating</b> </li> 054 * <li>6: QAK (Query Acknowledgment) <b> </b> </li> 055 * <li>7: QPD (Query Parameter Definition) <b> </b> </li> 056 * <li>8: RCP (Response Control Parameter) <b> </b> </li> 057 * <li>9: RSP_K25_STAFF (a Group object) <b> repeating</b> </li> 058 * <li>10: DSC (Continuation Pointer) <b>optional </b> </li> 059 * </ul> 060 */ 061//@SuppressWarnings("unused") 062public class RSP_K25 extends AbstractMessage { 063 064 /** 065 * Creates a new RSP_K25 message with DefaultModelClassFactory. 066 */ 067 public RSP_K25() { 068 this(new DefaultModelClassFactory()); 069 } 070 071 /** 072 * Creates a new RSP_K25 message with custom ModelClassFactory. 073 */ 074 public RSP_K25(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(ERR.class, false, true); 086 this.add(QAK.class, true, false); 087 this.add(QPD.class, true, false); 088 this.add(RCP.class, true, false); 089 this.add(RSP_K25_STAFF.class, true, true); 090 this.add(DSC.class, false, false); 091 } catch(HL7Exception e) { 092 log.error("Unexpected error creating RSP_K25 - this is probably a bug in the source code generator.", e); 093 } 094 } 095 096 097 /** 098 * Returns "2.7" 099 */ 100 public String getVersion() { 101 return "2.7"; 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 * the first repetition of 253 * ERR (Error) - creates it if necessary 254 * </p> 255 * 256 * 257 */ 258 public ERR getERR() { 259 return getTyped("ERR", ERR.class); 260 } 261 262 263 /** 264 * <p> 265 * Returns a specific repetition of 266 * ERR (Error) - creates it if necessary 267 * </p> 268 * 269 * 270 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 271 * @throws HL7Exception if the repetition requested is more than one 272 * greater than the number of existing repetitions. 273 */ 274 public ERR getERR(int rep) { 275 return getTyped("ERR", rep, ERR.class); 276 } 277 278 /** 279 * <p> 280 * Returns the number of existing repetitions of ERR 281 * </p> 282 * 283 */ 284 public int getERRReps() { 285 return getReps("ERR"); 286 } 287 288 /** 289 * <p> 290 * Returns a non-modifiable List containing all current existing repetitions of ERR. 291 * <p> 292 * <p> 293 * Note that unlike {@link #getERR()}, this method will not create any reps 294 * if none are already present, so an empty list may be returned. 295 * </p> 296 * 297 */ 298 public java.util.List<ERR> getERRAll() throws HL7Exception { 299 return getAllAsList("ERR", ERR.class); 300 } 301 302 /** 303 * <p> 304 * Inserts a specific repetition of ERR (Error) 305 * </p> 306 * 307 * 308 * @see AbstractGroup#insertRepetition(Structure, int) 309 */ 310 public void insertERR(ERR structure, int rep) throws HL7Exception { 311 super.insertRepetition( "ERR", structure, rep); 312 } 313 314 315 /** 316 * <p> 317 * Inserts a specific repetition of ERR (Error) 318 * </p> 319 * 320 * 321 * @see AbstractGroup#insertRepetition(Structure, int) 322 */ 323 public ERR insertERR(int rep) throws HL7Exception { 324 return (ERR)super.insertRepetition("ERR", rep); 325 } 326 327 328 /** 329 * <p> 330 * Removes a specific repetition of ERR (Error) 331 * </p> 332 * 333 * 334 * @see AbstractGroup#removeRepetition(String, int) 335 */ 336 public ERR removeERR(int rep) throws HL7Exception { 337 return (ERR)super.removeRepetition("ERR", rep); 338 } 339 340 341 342 343 /** 344 * <p> 345 * Returns 346 * QAK (Query Acknowledgment) - creates it if necessary 347 * </p> 348 * 349 * 350 */ 351 public QAK getQAK() { 352 return getTyped("QAK", QAK.class); 353 } 354 355 356 357 358 359 /** 360 * <p> 361 * Returns 362 * QPD (Query Parameter Definition) - creates it if necessary 363 * </p> 364 * 365 * 366 */ 367 public QPD getQPD() { 368 return getTyped("QPD", QPD.class); 369 } 370 371 372 373 374 375 /** 376 * <p> 377 * Returns 378 * RCP (Response Control Parameter) - creates it if necessary 379 * </p> 380 * 381 * 382 */ 383 public RCP getRCP() { 384 return getTyped("RCP", RCP.class); 385 } 386 387 388 389 390 391 /** 392 * <p> 393 * Returns 394 * the first repetition of 395 * STAFF (a Group object) - creates it if necessary 396 * </p> 397 * 398 * 399 */ 400 public RSP_K25_STAFF getSTAFF() { 401 return getTyped("STAFF", RSP_K25_STAFF.class); 402 } 403 404 405 /** 406 * <p> 407 * Returns a specific repetition of 408 * STAFF (a Group object) - creates it if necessary 409 * </p> 410 * 411 * 412 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 413 * @throws HL7Exception if the repetition requested is more than one 414 * greater than the number of existing repetitions. 415 */ 416 public RSP_K25_STAFF getSTAFF(int rep) { 417 return getTyped("STAFF", rep, RSP_K25_STAFF.class); 418 } 419 420 /** 421 * <p> 422 * Returns the number of existing repetitions of STAFF 423 * </p> 424 * 425 */ 426 public int getSTAFFReps() { 427 return getReps("STAFF"); 428 } 429 430 /** 431 * <p> 432 * Returns a non-modifiable List containing all current existing repetitions of STAFF. 433 * <p> 434 * <p> 435 * Note that unlike {@link #getSTAFF()}, this method will not create any reps 436 * if none are already present, so an empty list may be returned. 437 * </p> 438 * 439 */ 440 public java.util.List<RSP_K25_STAFF> getSTAFFAll() throws HL7Exception { 441 return getAllAsList("STAFF", RSP_K25_STAFF.class); 442 } 443 444 /** 445 * <p> 446 * Inserts a specific repetition of STAFF (a Group object) 447 * </p> 448 * 449 * 450 * @see AbstractGroup#insertRepetition(Structure, int) 451 */ 452 public void insertSTAFF(RSP_K25_STAFF structure, int rep) throws HL7Exception { 453 super.insertRepetition( "STAFF", structure, rep); 454 } 455 456 457 /** 458 * <p> 459 * Inserts a specific repetition of STAFF (a Group object) 460 * </p> 461 * 462 * 463 * @see AbstractGroup#insertRepetition(Structure, int) 464 */ 465 public RSP_K25_STAFF insertSTAFF(int rep) throws HL7Exception { 466 return (RSP_K25_STAFF)super.insertRepetition("STAFF", rep); 467 } 468 469 470 /** 471 * <p> 472 * Removes a specific repetition of STAFF (a Group object) 473 * </p> 474 * 475 * 476 * @see AbstractGroup#removeRepetition(String, int) 477 */ 478 public RSP_K25_STAFF removeSTAFF(int rep) throws HL7Exception { 479 return (RSP_K25_STAFF)super.removeRepetition("STAFF", rep); 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