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.v27.message; 035 036import ca.uhn.hl7v2.model.v27.group.*; 037import ca.uhn.hl7v2.model.v27.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 OUL_R24 message structure (see chapter 7.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: UAC (User Authentication Credential Segment) <b>optional </b> </li> 052 * <li>4: NTE (Notes and Comments) <b>optional </b> </li> 053 * <li>5: OUL_R24_PATIENT (a Group object) <b>optional </b> </li> 054 * <li>6: NK1 (Next of Kin / Associated Parties) <b>optional repeating</b> </li> 055 * <li>7: OUL_R24_ORDER (a Group object) <b> repeating</b> </li> 056 * <li>8: DSC (Continuation Pointer) <b>optional </b> </li> 057 * </ul> 058 */ 059//@SuppressWarnings("unused") 060public class OUL_R24 extends AbstractMessage { 061 062 /** 063 * Creates a new OUL_R24 message with DefaultModelClassFactory. 064 */ 065 public OUL_R24() { 066 this(new DefaultModelClassFactory()); 067 } 068 069 /** 070 * Creates a new OUL_R24 message with custom ModelClassFactory. 071 */ 072 public OUL_R24(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(NTE.class, false, false); 083 this.add(OUL_R24_PATIENT.class, false, false); 084 this.add(NK1.class, false, true); 085 this.add(OUL_R24_ORDER.class, true, true); 086 this.add(DSC.class, false, false); 087 } catch(HL7Exception e) { 088 log.error("Unexpected error creating OUL_R24 - this is probably a bug in the source code generator.", e); 089 } 090 } 091 092 093 /** 094 * Returns "2.7" 095 */ 096 public String getVersion() { 097 return "2.7"; 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 * NTE (Notes and Comments) - creates it if necessary 233 * </p> 234 * 235 * 236 */ 237 public NTE getNTE() { 238 return getTyped("NTE", NTE.class); 239 } 240 241 242 243 244 245 /** 246 * <p> 247 * Returns 248 * PATIENT (a Group object) - creates it if necessary 249 * </p> 250 * 251 * 252 */ 253 public OUL_R24_PATIENT getPATIENT() { 254 return getTyped("PATIENT", OUL_R24_PATIENT.class); 255 } 256 257 258 259 260 261 /** 262 * <p> 263 * Returns 264 * the first repetition of 265 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 266 * </p> 267 * 268 * 269 */ 270 public NK1 getNK1() { 271 return getTyped("NK1", NK1.class); 272 } 273 274 275 /** 276 * <p> 277 * Returns a specific repetition of 278 * NK1 (Next of Kin / Associated Parties) - creates it if necessary 279 * </p> 280 * 281 * 282 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 283 * @throws HL7Exception if the repetition requested is more than one 284 * greater than the number of existing repetitions. 285 */ 286 public NK1 getNK1(int rep) { 287 return getTyped("NK1", rep, NK1.class); 288 } 289 290 /** 291 * <p> 292 * Returns the number of existing repetitions of NK1 293 * </p> 294 * 295 */ 296 public int getNK1Reps() { 297 return getReps("NK1"); 298 } 299 300 /** 301 * <p> 302 * Returns a non-modifiable List containing all current existing repetitions of NK1. 303 * <p> 304 * <p> 305 * Note that unlike {@link #getNK1()}, this method will not create any reps 306 * if none are already present, so an empty list may be returned. 307 * </p> 308 * 309 */ 310 public java.util.List<NK1> getNK1All() throws HL7Exception { 311 return getAllAsList("NK1", NK1.class); 312 } 313 314 /** 315 * <p> 316 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 317 * </p> 318 * 319 * 320 * @see AbstractGroup#insertRepetition(Structure, int) 321 */ 322 public void insertNK1(NK1 structure, int rep) throws HL7Exception { 323 super.insertRepetition( "NK1", structure, rep); 324 } 325 326 327 /** 328 * <p> 329 * Inserts a specific repetition of NK1 (Next of Kin / Associated Parties) 330 * </p> 331 * 332 * 333 * @see AbstractGroup#insertRepetition(Structure, int) 334 */ 335 public NK1 insertNK1(int rep) throws HL7Exception { 336 return (NK1)super.insertRepetition("NK1", rep); 337 } 338 339 340 /** 341 * <p> 342 * Removes a specific repetition of NK1 (Next of Kin / Associated Parties) 343 * </p> 344 * 345 * 346 * @see AbstractGroup#removeRepetition(String, int) 347 */ 348 public NK1 removeNK1(int rep) throws HL7Exception { 349 return (NK1)super.removeRepetition("NK1", rep); 350 } 351 352 353 354 355 /** 356 * <p> 357 * Returns 358 * the first repetition of 359 * ORDER (a Group object) - creates it if necessary 360 * </p> 361 * 362 * 363 */ 364 public OUL_R24_ORDER getORDER() { 365 return getTyped("ORDER", OUL_R24_ORDER.class); 366 } 367 368 369 /** 370 * <p> 371 * Returns a specific repetition of 372 * ORDER (a Group object) - creates it if necessary 373 * </p> 374 * 375 * 376 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 377 * @throws HL7Exception if the repetition requested is more than one 378 * greater than the number of existing repetitions. 379 */ 380 public OUL_R24_ORDER getORDER(int rep) { 381 return getTyped("ORDER", rep, OUL_R24_ORDER.class); 382 } 383 384 /** 385 * <p> 386 * Returns the number of existing repetitions of ORDER 387 * </p> 388 * 389 */ 390 public int getORDERReps() { 391 return getReps("ORDER"); 392 } 393 394 /** 395 * <p> 396 * Returns a non-modifiable List containing all current existing repetitions of ORDER. 397 * <p> 398 * <p> 399 * Note that unlike {@link #getORDER()}, this method will not create any reps 400 * if none are already present, so an empty list may be returned. 401 * </p> 402 * 403 */ 404 public java.util.List<OUL_R24_ORDER> getORDERAll() throws HL7Exception { 405 return getAllAsList("ORDER", OUL_R24_ORDER.class); 406 } 407 408 /** 409 * <p> 410 * Inserts a specific repetition of ORDER (a Group object) 411 * </p> 412 * 413 * 414 * @see AbstractGroup#insertRepetition(Structure, int) 415 */ 416 public void insertORDER(OUL_R24_ORDER structure, int rep) throws HL7Exception { 417 super.insertRepetition( "ORDER", structure, rep); 418 } 419 420 421 /** 422 * <p> 423 * Inserts a specific repetition of ORDER (a Group object) 424 * </p> 425 * 426 * 427 * @see AbstractGroup#insertRepetition(Structure, int) 428 */ 429 public OUL_R24_ORDER insertORDER(int rep) throws HL7Exception { 430 return (OUL_R24_ORDER)super.insertRepetition("ORDER", rep); 431 } 432 433 434 /** 435 * <p> 436 * Removes a specific repetition of ORDER (a Group object) 437 * </p> 438 * 439 * 440 * @see AbstractGroup#removeRepetition(String, int) 441 */ 442 public OUL_R24_ORDER removeORDER(int rep) throws HL7Exception { 443 return (OUL_R24_ORDER)super.removeRepetition("ORDER", rep); 444 } 445 446 447 448 449 /** 450 * <p> 451 * Returns 452 * DSC (Continuation Pointer) - creates it if necessary 453 * </p> 454 * 455 * 456 */ 457 public DSC getDSC() { 458 return getTyped("DSC", DSC.class); 459 } 460 461 462 463 464} 465