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