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.v25.message; 35 36 import ca.uhn.hl7v2.model.v25.group.*; 37 import ca.uhn.hl7v2.model.v25.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 RTB_Z74 message structure (see chapter 4.6.2). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (Message Header) <b> </b> </li> 50 * <li>2: MSA (Message Acknowledgment) <b> </b> </li> 51 * <li>3: ERR (Error) <b>optional repeating</b> </li> 52 * <li>4: SFT (Software Segment) <b>optional repeating</b> </li> 53 * <li>5: QAK (Query Acknowledgment) <b> </b> </li> 54 * <li>6: QPD (Query Parameter Definition) <b> </b> </li> 55 * <li>7: RTB_Z74_ROW_DEFINITION (a Group object) <b>optional </b> </li> 56 * <li>8: DSC (Continuation Pointer) <b>optional </b> </li> 57 * </ul> 58 */ 59 //@SuppressWarnings("unused") 60 public class RTB_Z74 extends AbstractMessage { 61 62 /** 63 * Creates a new RTB_Z74 message with DefaultModelClassFactory. 64 */ 65 public RTB_Z74() { 66 this(new DefaultModelClassFactory()); 67 } 68 69 /** 70 * Creates a new RTB_Z74 message with custom ModelClassFactory. 71 */ 72 public RTB_Z74(ModelClassFactory factory) { 73 super(factory); 74 init(factory); 75 } 76 77 private void init(ModelClassFactory factory) { 78 try { 79 this.add(MSH.class, true, false); 80 this.add(MSA.class, true, false); 81 this.add(ERR.class, false, true); 82 this.add(SFT.class, false, true); 83 this.add(QAK.class, true, false); 84 this.add(QPD.class, true, false); 85 this.add(RTB_Z74_ROW_DEFINITION.class, false, false); 86 this.add(DSC.class, false, false); 87 } catch(HL7Exception e) { 88 log.error("Unexpected error creating RTB_Z74 - this is probably a bug in the source code generator.", e); 89 } 90 } 91 92 93 /** 94 * Returns "2.5" 95 */ 96 public String getVersion() { 97 return "2.5"; 98 } 99 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 * MSA (Message Acknowledgment) - creates it if necessary 123 * </p> 124 * 125 * 126 */ 127 public MSA getMSA() { 128 return getTyped("MSA", MSA.class); 129 } 130 131 132 133 134 135 /** 136 * <p> 137 * Returns 138 * the first repetition of 139 * ERR (Error) - creates it if necessary 140 * </p> 141 * 142 * 143 */ 144 public ERR getERR() { 145 return getTyped("ERR", ERR.class); 146 } 147 148 149 /** 150 * <p> 151 * Returns a specific repetition of 152 * ERR (Error) - creates it if necessary 153 * </p> 154 * 155 * 156 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 157 * @throws HL7Exception if the repetition requested is more than one 158 * greater than the number of existing repetitions. 159 */ 160 public ERR getERR(int rep) { 161 return getTyped("ERR", rep, ERR.class); 162 } 163 164 /** 165 * <p> 166 * Returns the number of existing repetitions of ERR 167 * </p> 168 * 169 */ 170 public int getERRReps() { 171 return getReps("ERR"); 172 } 173 174 /** 175 * <p> 176 * Returns a non-modifiable List containing all current existing repetitions of ERR. 177 * <p> 178 * <p> 179 * Note that unlike {@link #getERR()}, this method will not create any reps 180 * if none are already present, so an empty list may be returned. 181 * </p> 182 * 183 */ 184 public java.util.List<ERR> getERRAll() throws HL7Exception { 185 return getAllAsList("ERR", ERR.class); 186 } 187 188 /** 189 * <p> 190 * Inserts a specific repetition of ERR (Error) 191 * </p> 192 * 193 * 194 * @see AbstractGroup#insertRepetition(Structure, int) 195 */ 196 public void insertERR(ERR structure, int rep) throws HL7Exception { 197 super.insertRepetition( "ERR", structure, rep); 198 } 199 200 201 /** 202 * <p> 203 * Inserts a specific repetition of ERR (Error) 204 * </p> 205 * 206 * 207 * @see AbstractGroup#insertRepetition(Structure, int) 208 */ 209 public ERR insertERR(int rep) throws HL7Exception { 210 return (ERR)super.insertRepetition("ERR", rep); 211 } 212 213 214 /** 215 * <p> 216 * Removes a specific repetition of ERR (Error) 217 * </p> 218 * 219 * 220 * @see AbstractGroup#removeRepetition(String, int) 221 */ 222 public ERR removeERR(int rep) throws HL7Exception { 223 return (ERR)super.removeRepetition("ERR", rep); 224 } 225 226 227 228 229 /** 230 * <p> 231 * Returns 232 * the first repetition of 233 * SFT (Software Segment) - creates it if necessary 234 * </p> 235 * 236 * 237 */ 238 public SFT getSFT() { 239 return getTyped("SFT", SFT.class); 240 } 241 242 243 /** 244 * <p> 245 * Returns a specific repetition of 246 * SFT (Software Segment) - creates it if necessary 247 * </p> 248 * 249 * 250 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 251 * @throws HL7Exception if the repetition requested is more than one 252 * greater than the number of existing repetitions. 253 */ 254 public SFT getSFT(int rep) { 255 return getTyped("SFT", rep, SFT.class); 256 } 257 258 /** 259 * <p> 260 * Returns the number of existing repetitions of SFT 261 * </p> 262 * 263 */ 264 public int getSFTReps() { 265 return getReps("SFT"); 266 } 267 268 /** 269 * <p> 270 * Returns a non-modifiable List containing all current existing repetitions of SFT. 271 * <p> 272 * <p> 273 * Note that unlike {@link #getSFT()}, this method will not create any reps 274 * if none are already present, so an empty list may be returned. 275 * </p> 276 * 277 */ 278 public java.util.List<SFT> getSFTAll() throws HL7Exception { 279 return getAllAsList("SFT", SFT.class); 280 } 281 282 /** 283 * <p> 284 * Inserts a specific repetition of SFT (Software Segment) 285 * </p> 286 * 287 * 288 * @see AbstractGroup#insertRepetition(Structure, int) 289 */ 290 public void insertSFT(SFT structure, int rep) throws HL7Exception { 291 super.insertRepetition( "SFT", structure, rep); 292 } 293 294 295 /** 296 * <p> 297 * Inserts a specific repetition of SFT (Software Segment) 298 * </p> 299 * 300 * 301 * @see AbstractGroup#insertRepetition(Structure, int) 302 */ 303 public SFT insertSFT(int rep) throws HL7Exception { 304 return (SFT)super.insertRepetition("SFT", rep); 305 } 306 307 308 /** 309 * <p> 310 * Removes a specific repetition of SFT (Software Segment) 311 * </p> 312 * 313 * 314 * @see AbstractGroup#removeRepetition(String, int) 315 */ 316 public SFT removeSFT(int rep) throws HL7Exception { 317 return (SFT)super.removeRepetition("SFT", rep); 318 } 319 320 321 322 323 /** 324 * <p> 325 * Returns 326 * QAK (Query Acknowledgment) - creates it if necessary 327 * </p> 328 * 329 * 330 */ 331 public QAK getQAK() { 332 return getTyped("QAK", QAK.class); 333 } 334 335 336 337 338 339 /** 340 * <p> 341 * Returns 342 * QPD (Query Parameter Definition) - creates it if necessary 343 * </p> 344 * 345 * 346 */ 347 public QPD getQPD() { 348 return getTyped("QPD", QPD.class); 349 } 350 351 352 353 354 355 /** 356 * <p> 357 * Returns 358 * ROW_DEFINITION (a Group object) - creates it if necessary 359 * </p> 360 * 361 * 362 */ 363 public RTB_Z74_ROW_DEFINITION getROW_DEFINITION() { 364 return getTyped("ROW_DEFINITION", RTB_Z74_ROW_DEFINITION.class); 365 } 366 367 368 369 370 371 /** 372 * <p> 373 * Returns 374 * DSC (Continuation Pointer) - creates it if necessary 375 * </p> 376 * 377 * 378 */ 379 public DSC getDSC() { 380 return getTyped("DSC", DSC.class); 381 } 382 383 384 385 386 } 387