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