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