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.v27.message; 35 36 import ca.uhn.hl7v2.model.v27.group.*; 37 import ca.uhn.hl7v2.model.v27.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 ORG_O20 message structure (see chapter 4.4.5). 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: UAC (User Authentication Credential Segment) <b>optional </b> </li> 54 * <li>6: NTE (Notes and Comments) <b>optional repeating</b> </li> 55 * <li>7: ORG_O20_RESPONSE (a Group object) <b>optional </b> </li> 56 * </ul> 57 */ 58 //@SuppressWarnings("unused") 59 public class ORG_O20 extends AbstractMessage { 60 61 /** 62 * Creates a new ORG_O20 message with DefaultModelClassFactory. 63 */ 64 public ORG_O20() { 65 this(new DefaultModelClassFactory()); 66 } 67 68 /** 69 * Creates a new ORG_O20 message with custom ModelClassFactory. 70 */ 71 public ORG_O20(ModelClassFactory factory) { 72 super(factory); 73 init(factory); 74 } 75 76 private void init(ModelClassFactory factory) { 77 try { 78 this.add(MSH.class, true, false); 79 this.add(MSA.class, true, false); 80 this.add(ERR.class, false, true); 81 this.add(SFT.class, false, true); 82 this.add(UAC.class, false, false); 83 this.add(NTE.class, false, true); 84 this.add(ORG_O20_RESPONSE.class, false, false); 85 } catch(HL7Exception e) { 86 log.error("Unexpected error creating ORG_O20 - this is probably a bug in the source code generator.", e); 87 } 88 } 89 90 91 /** 92 * Returns "2.7" 93 */ 94 public String getVersion() { 95 return "2.7"; 96 } 97 98 99 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 * MSA (Message Acknowledgment) - creates it if necessary 121 * </p> 122 * 123 * 124 */ 125 public MSA getMSA() { 126 return getTyped("MSA", MSA.class); 127 } 128 129 130 131 132 133 /** 134 * <p> 135 * Returns 136 * the first repetition of 137 * ERR (Error) - creates it if necessary 138 * </p> 139 * 140 * 141 */ 142 public ERR getERR() { 143 return getTyped("ERR", ERR.class); 144 } 145 146 147 /** 148 * <p> 149 * Returns a specific repetition of 150 * ERR (Error) - creates it if necessary 151 * </p> 152 * 153 * 154 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 155 * @throws HL7Exception if the repetition requested is more than one 156 * greater than the number of existing repetitions. 157 */ 158 public ERR getERR(int rep) { 159 return getTyped("ERR", rep, ERR.class); 160 } 161 162 /** 163 * <p> 164 * Returns the number of existing repetitions of ERR 165 * </p> 166 * 167 */ 168 public int getERRReps() { 169 return getReps("ERR"); 170 } 171 172 /** 173 * <p> 174 * Returns a non-modifiable List containing all current existing repetitions of ERR. 175 * <p> 176 * <p> 177 * Note that unlike {@link #getERR()}, this method will not create any reps 178 * if none are already present, so an empty list may be returned. 179 * </p> 180 * 181 */ 182 public java.util.List<ERR> getERRAll() throws HL7Exception { 183 return getAllAsList("ERR", ERR.class); 184 } 185 186 /** 187 * <p> 188 * Inserts a specific repetition of ERR (Error) 189 * </p> 190 * 191 * 192 * @see AbstractGroup#insertRepetition(Structure, int) 193 */ 194 public void insertERR(ERR structure, int rep) throws HL7Exception { 195 super.insertRepetition( "ERR", structure, rep); 196 } 197 198 199 /** 200 * <p> 201 * Inserts a specific repetition of ERR (Error) 202 * </p> 203 * 204 * 205 * @see AbstractGroup#insertRepetition(Structure, int) 206 */ 207 public ERR insertERR(int rep) throws HL7Exception { 208 return (ERR)super.insertRepetition("ERR", rep); 209 } 210 211 212 /** 213 * <p> 214 * Removes a specific repetition of ERR (Error) 215 * </p> 216 * 217 * 218 * @see AbstractGroup#removeRepetition(String, int) 219 */ 220 public ERR removeERR(int rep) throws HL7Exception { 221 return (ERR)super.removeRepetition("ERR", rep); 222 } 223 224 225 226 227 /** 228 * <p> 229 * Returns 230 * the first repetition of 231 * SFT (Software Segment) - creates it if necessary 232 * </p> 233 * 234 * 235 */ 236 public SFT getSFT() { 237 return getTyped("SFT", SFT.class); 238 } 239 240 241 /** 242 * <p> 243 * Returns a specific repetition of 244 * SFT (Software Segment) - 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 SFT getSFT(int rep) { 253 return getTyped("SFT", rep, SFT.class); 254 } 255 256 /** 257 * <p> 258 * Returns the number of existing repetitions of SFT 259 * </p> 260 * 261 */ 262 public int getSFTReps() { 263 return getReps("SFT"); 264 } 265 266 /** 267 * <p> 268 * Returns a non-modifiable List containing all current existing repetitions of SFT. 269 * <p> 270 * <p> 271 * Note that unlike {@link #getSFT()}, 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<SFT> getSFTAll() throws HL7Exception { 277 return getAllAsList("SFT", SFT.class); 278 } 279 280 /** 281 * <p> 282 * Inserts a specific repetition of SFT (Software Segment) 283 * </p> 284 * 285 * 286 * @see AbstractGroup#insertRepetition(Structure, int) 287 */ 288 public void insertSFT(SFT structure, int rep) throws HL7Exception { 289 super.insertRepetition( "SFT", structure, rep); 290 } 291 292 293 /** 294 * <p> 295 * Inserts a specific repetition of SFT (Software Segment) 296 * </p> 297 * 298 * 299 * @see AbstractGroup#insertRepetition(Structure, int) 300 */ 301 public SFT insertSFT(int rep) throws HL7Exception { 302 return (SFT)super.insertRepetition("SFT", rep); 303 } 304 305 306 /** 307 * <p> 308 * Removes a specific repetition of SFT (Software Segment) 309 * </p> 310 * 311 * 312 * @see AbstractGroup#removeRepetition(String, int) 313 */ 314 public SFT removeSFT(int rep) throws HL7Exception { 315 return (SFT)super.removeRepetition("SFT", rep); 316 } 317 318 319 320 321 /** 322 * <p> 323 * Returns 324 * UAC (User Authentication Credential Segment) - creates it if necessary 325 * </p> 326 * 327 * 328 */ 329 public UAC getUAC() { 330 return getTyped("UAC", UAC.class); 331 } 332 333 334 335 336 337 /** 338 * <p> 339 * Returns 340 * the first repetition of 341 * NTE (Notes and Comments) - creates it if necessary 342 * </p> 343 * 344 * 345 */ 346 public NTE getNTE() { 347 return getTyped("NTE", NTE.class); 348 } 349 350 351 /** 352 * <p> 353 * Returns a specific repetition of 354 * NTE (Notes and Comments) - creates it if necessary 355 * </p> 356 * 357 * 358 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 359 * @throws HL7Exception if the repetition requested is more than one 360 * greater than the number of existing repetitions. 361 */ 362 public NTE getNTE(int rep) { 363 return getTyped("NTE", rep, NTE.class); 364 } 365 366 /** 367 * <p> 368 * Returns the number of existing repetitions of NTE 369 * </p> 370 * 371 */ 372 public int getNTEReps() { 373 return getReps("NTE"); 374 } 375 376 /** 377 * <p> 378 * Returns a non-modifiable List containing all current existing repetitions of NTE. 379 * <p> 380 * <p> 381 * Note that unlike {@link #getNTE()}, this method will not create any reps 382 * if none are already present, so an empty list may be returned. 383 * </p> 384 * 385 */ 386 public java.util.List<NTE> getNTEAll() throws HL7Exception { 387 return getAllAsList("NTE", NTE.class); 388 } 389 390 /** 391 * <p> 392 * Inserts a specific repetition of NTE (Notes and Comments) 393 * </p> 394 * 395 * 396 * @see AbstractGroup#insertRepetition(Structure, int) 397 */ 398 public void insertNTE(NTE structure, int rep) throws HL7Exception { 399 super.insertRepetition( "NTE", structure, rep); 400 } 401 402 403 /** 404 * <p> 405 * Inserts a specific repetition of NTE (Notes and Comments) 406 * </p> 407 * 408 * 409 * @see AbstractGroup#insertRepetition(Structure, int) 410 */ 411 public NTE insertNTE(int rep) throws HL7Exception { 412 return (NTE)super.insertRepetition("NTE", rep); 413 } 414 415 416 /** 417 * <p> 418 * Removes a specific repetition of NTE (Notes and Comments) 419 * </p> 420 * 421 * 422 * @see AbstractGroup#removeRepetition(String, int) 423 */ 424 public NTE removeNTE(int rep) throws HL7Exception { 425 return (NTE)super.removeRepetition("NTE", rep); 426 } 427 428 429 430 431 /** 432 * <p> 433 * Returns 434 * RESPONSE (a Group object) - creates it if necessary 435 * </p> 436 * 437 * 438 */ 439 public ORG_O20_RESPONSE getRESPONSE() { 440 return getTyped("RESPONSE", ORG_O20_RESPONSE.class); 441 } 442 443 444 445 446 } 447