1 /* 2 * This class is an auto-generated source file for a HAPI 3 * HL7 v2.x standard structure class. 4 * 5 * For more information, visit: http://hl7api.sourceforge.net/ 6 * 7 * The contents of this file are subject to the Mozilla Public License Version 1.1 8 * (the "License"); you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 12 * specific language governing rights and limitations under the License. 13 * 14 * The Original Code is "[file_name]". Description: 15 * "[one_line_description]" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2012. All Rights Reserved. 19 * 20 * Contributor(s): ______________________________________. 21 * 22 * Alternatively, the contents of this file may be used under the terms of the 23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 24 * applicable instead of those above. If you wish to allow use of your version of this 25 * file only under the terms of the GPL and not to allow others to use your version 26 * of this file under the MPL, indicate your decision by deleting the provisions above 27 * and replace them with the notice and other provisions required by the GPL License. 28 * If you do not delete the provisions above, a recipient may use your version of 29 * this file under either the MPL or the GPL. 30 * 31 */ 32 33 34 package ca.uhn.hl7v2.model.v28.message; 35 36 import ca.uhn.hl7v2.model.v28.group.*; 37 import ca.uhn.hl7v2.model.v28.segment.*; 38 39 import ca.uhn.hl7v2.HL7Exception; 40 import ca.uhn.hl7v2.parser.ModelClassFactory; 41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 42 import ca.uhn.hl7v2.model.*; 43 44 45 /** 46 * <p>Represents a RSP_Z82 message structure (see chapter 5.9.1.1.1). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (Message Header) <b> </b> </li> 50 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li> 51 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b> </li> 52 * <li>4: MSA (Message Acknowledgment) <b> </b> </li> 53 * <li>5: ERR (Error) <b>optional </b> </li> 54 * <li>6: QAK (Query Acknowledgment) <b> </b> </li> 55 * <li>7: QPD (Query Parameter Definition) <b> </b> </li> 56 * <li>8: RCP (Response Control Parameter) <b> </b> </li> 57 * <li>9: RSP_Z82_QUERY_RESPONSE (a Group object) <b> repeating</b> </li> 58 * <li>10: DSC (Continuation Pointer) <b>optional </b> </li> 59 * </ul> 60 */ 61 //@SuppressWarnings("unused") 62 public class RSP_Z82 extends AbstractMessage { 63 64 /** 65 * Creates a new RSP_Z82 message with DefaultModelClassFactory. 66 */ 67 public RSP_Z82() { 68 this(new DefaultModelClassFactory()); 69 } 70 71 /** 72 * Creates a new RSP_Z82 message with custom ModelClassFactory. 73 */ 74 public RSP_Z82(ModelClassFactory factory) { 75 super(factory); 76 init(factory); 77 } 78 79 private void init(ModelClassFactory factory) { 80 try { 81 this.add(MSH.class, true, false); 82 this.add(SFT.class, false, true); 83 this.add(UAC.class, false, false); 84 this.add(MSA.class, true, false); 85 this.add(ERR.class, false, false); 86 this.add(QAK.class, true, false); 87 this.add(QPD.class, true, false); 88 this.add(RCP.class, true, false); 89 this.add(RSP_Z82_QUERY_RESPONSE.class, true, true); 90 this.add(DSC.class, false, false); 91 } catch(HL7Exception e) { 92 log.error("Unexpected error creating RSP_Z82 - this is probably a bug in the source code generator.", e); 93 } 94 } 95 96 97 /** 98 * Returns "2.8" 99 */ 100 public String getVersion() { 101 return "2.8"; 102 } 103 104 105 106 107 /** 108 * <p> 109 * Returns 110 * MSH (Message Header) - creates it if necessary 111 * </p> 112 * 113 * 114 */ 115 public MSH getMSH() { 116 return getTyped("MSH", MSH.class); 117 } 118 119 120 121 122 123 /** 124 * <p> 125 * Returns 126 * the first repetition of 127 * SFT (Software Segment) - creates it if necessary 128 * </p> 129 * 130 * 131 */ 132 public SFT getSFT() { 133 return getTyped("SFT", SFT.class); 134 } 135 136 137 /** 138 * <p> 139 * Returns a specific repetition of 140 * SFT (Software Segment) - creates it if necessary 141 * </p> 142 * 143 * 144 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 145 * @throws HL7Exception if the repetition requested is more than one 146 * greater than the number of existing repetitions. 147 */ 148 public SFT getSFT(int rep) { 149 return getTyped("SFT", rep, SFT.class); 150 } 151 152 /** 153 * <p> 154 * Returns the number of existing repetitions of SFT 155 * </p> 156 * 157 */ 158 public int getSFTReps() { 159 return getReps("SFT"); 160 } 161 162 /** 163 * <p> 164 * Returns a non-modifiable List containing all current existing repetitions of SFT. 165 * <p> 166 * <p> 167 * Note that unlike {@link #getSFT()}, this method will not create any reps 168 * if none are already present, so an empty list may be returned. 169 * </p> 170 * 171 */ 172 public java.util.List<SFT> getSFTAll() throws HL7Exception { 173 return getAllAsList("SFT", SFT.class); 174 } 175 176 /** 177 * <p> 178 * Inserts a specific repetition of SFT (Software Segment) 179 * </p> 180 * 181 * 182 * @see AbstractGroup#insertRepetition(Structure, int) 183 */ 184 public void insertSFT(SFT structure, int rep) throws HL7Exception { 185 super.insertRepetition( "SFT", structure, rep); 186 } 187 188 189 /** 190 * <p> 191 * Inserts a specific repetition of SFT (Software Segment) 192 * </p> 193 * 194 * 195 * @see AbstractGroup#insertRepetition(Structure, int) 196 */ 197 public SFT insertSFT(int rep) throws HL7Exception { 198 return (SFT)super.insertRepetition("SFT", rep); 199 } 200 201 202 /** 203 * <p> 204 * Removes a specific repetition of SFT (Software Segment) 205 * </p> 206 * 207 * 208 * @see AbstractGroup#removeRepetition(String, int) 209 */ 210 public SFT removeSFT(int rep) throws HL7Exception { 211 return (SFT)super.removeRepetition("SFT", rep); 212 } 213 214 215 216 217 /** 218 * <p> 219 * Returns 220 * UAC (User Authentication Credential Segment) - creates it if necessary 221 * </p> 222 * 223 * 224 */ 225 public UAC getUAC() { 226 return getTyped("UAC", UAC.class); 227 } 228 229 230 231 232 233 /** 234 * <p> 235 * Returns 236 * MSA (Message Acknowledgment) - creates it if necessary 237 * </p> 238 * 239 * 240 */ 241 public MSA getMSA() { 242 return getTyped("MSA", MSA.class); 243 } 244 245 246 247 248 249 /** 250 * <p> 251 * Returns 252 * ERR (Error) - creates it if necessary 253 * </p> 254 * 255 * 256 */ 257 public ERR getERR() { 258 return getTyped("ERR", ERR.class); 259 } 260 261 262 263 264 265 /** 266 * <p> 267 * Returns 268 * QAK (Query Acknowledgment) - creates it if necessary 269 * </p> 270 * 271 * 272 */ 273 public QAK getQAK() { 274 return getTyped("QAK", QAK.class); 275 } 276 277 278 279 280 281 /** 282 * <p> 283 * Returns 284 * QPD (Query Parameter Definition) - creates it if necessary 285 * </p> 286 * 287 * 288 */ 289 public QPD getQPD() { 290 return getTyped("QPD", QPD.class); 291 } 292 293 294 295 296 297 /** 298 * <p> 299 * Returns 300 * RCP (Response Control Parameter) - creates it if necessary 301 * </p> 302 * 303 * 304 */ 305 public RCP getRCP() { 306 return getTyped("RCP", RCP.class); 307 } 308 309 310 311 312 313 /** 314 * <p> 315 * Returns 316 * the first repetition of 317 * QUERY_RESPONSE (a Group object) - creates it if necessary 318 * </p> 319 * 320 * 321 */ 322 public RSP_Z82_QUERY_RESPONSE getQUERY_RESPONSE() { 323 return getTyped("QUERY_RESPONSE", RSP_Z82_QUERY_RESPONSE.class); 324 } 325 326 327 /** 328 * <p> 329 * Returns a specific repetition of 330 * QUERY_RESPONSE (a Group object) - creates it if necessary 331 * </p> 332 * 333 * 334 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 335 * @throws HL7Exception if the repetition requested is more than one 336 * greater than the number of existing repetitions. 337 */ 338 public RSP_Z82_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 339 return getTyped("QUERY_RESPONSE", rep, RSP_Z82_QUERY_RESPONSE.class); 340 } 341 342 /** 343 * <p> 344 * Returns the number of existing repetitions of QUERY_RESPONSE 345 * </p> 346 * 347 */ 348 public int getQUERY_RESPONSEReps() { 349 return getReps("QUERY_RESPONSE"); 350 } 351 352 /** 353 * <p> 354 * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE. 355 * <p> 356 * <p> 357 * Note that unlike {@link #getQUERY_RESPONSE()}, this method will not create any reps 358 * if none are already present, so an empty list may be returned. 359 * </p> 360 * 361 */ 362 public java.util.List<RSP_Z82_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception { 363 return getAllAsList("QUERY_RESPONSE", RSP_Z82_QUERY_RESPONSE.class); 364 } 365 366 /** 367 * <p> 368 * Inserts a specific repetition of QUERY_RESPONSE (a Group object) 369 * </p> 370 * 371 * 372 * @see AbstractGroup#insertRepetition(Structure, int) 373 */ 374 public void insertQUERY_RESPONSE(RSP_Z82_QUERY_RESPONSE structure, int rep) throws HL7Exception { 375 super.insertRepetition( "QUERY_RESPONSE", structure, rep); 376 } 377 378 379 /** 380 * <p> 381 * Inserts a specific repetition of QUERY_RESPONSE (a Group object) 382 * </p> 383 * 384 * 385 * @see AbstractGroup#insertRepetition(Structure, int) 386 */ 387 public RSP_Z82_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 388 return (RSP_Z82_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep); 389 } 390 391 392 /** 393 * <p> 394 * Removes a specific repetition of QUERY_RESPONSE (a Group object) 395 * </p> 396 * 397 * 398 * @see AbstractGroup#removeRepetition(String, int) 399 */ 400 public RSP_Z82_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 401 return (RSP_Z82_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", rep); 402 } 403 404 405 406 407 /** 408 * <p> 409 * Returns 410 * DSC (Continuation Pointer) - creates it if necessary 411 * </p> 412 * 413 * 414 */ 415 public DSC getDSC() { 416 return getTyped("DSC", DSC.class); 417 } 418 419 420 421 422 } 423