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