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