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