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.v26.group; 035 036import ca.uhn.hl7v2.model.v26.segment.*; 037 038import java.util.List; 039 040import ca.uhn.hl7v2.HL7Exception; 041import ca.uhn.hl7v2.parser.ModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044/** 045 * <p>Represents a EHC_E01_PRODUCT_SERVICE_LINE_ITEM group structure (a Group object). 046 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 047 * This Group contains the following elements: 048 * </p> 049 * <ul> 050 * <li>1: PSL (Product/Service Line Item) <b> </b></li> 051 * <li>2: NTE (Notes and Comments) <b>optional repeating</b></li> 052 * <li>3: ADJ (Adjustment) <b>optional repeating</b></li> 053 * <li>4: AUT (Authorization Information) <b>optional </b></li> 054 * <li>5: LOC (Location Identification) <b>optional repeating</b></li> 055 * <li>6: ROL (Role) <b>optional repeating</b></li> 056 * </ul> 057 */ 058@SuppressWarnings("unused") 059public class EHC_E01_PRODUCT_SERVICE_LINE_ITEM extends AbstractGroup { 060 061 /** 062 * Creates a new EHC_E01_PRODUCT_SERVICE_LINE_ITEM group 063 */ 064 public EHC_E01_PRODUCT_SERVICE_LINE_ITEM(Group parent, ModelClassFactory factory) { 065 super(parent, factory); 066 init(factory); 067 } 068 069 private void init(ModelClassFactory factory) { 070 try { 071 this.add(PSL.class, true, false); 072 this.add(NTE.class, false, true); 073 this.add(ADJ.class, false, true); 074 this.add(AUT.class, false, false); 075 this.add(LOC.class, false, true); 076 this.add(ROL.class, false, true); 077 } catch(HL7Exception e) { 078 log.error("Unexpected error creating EHC_E01_PRODUCT_SERVICE_LINE_ITEM - this is probably a bug in the source code generator.", e); 079 } 080 } 081 082 /** 083 * Returns "2.6" 084 */ 085 public String getVersion() { 086 return "2.6"; 087 } 088 089 090 091 /** 092 * Returns 093 * PSL (Product/Service Line Item) - creates it if necessary 094 */ 095 public PSL getPSL() { 096 PSL retVal = getTyped("PSL", PSL.class); 097 return retVal; 098 } 099 100 101 102 103 /** 104 * Returns 105 * the first repetition of 106 * NTE (Notes and Comments) - creates it if necessary 107 */ 108 public NTE getNTE() { 109 NTE retVal = getTyped("NTE", NTE.class); 110 return retVal; 111 } 112 113 114 /** 115 * Returns a specific repetition of 116 * NTE (Notes and Comments) - creates it if necessary 117 * 118 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 119 * @throws HL7Exception if the repetition requested is more than one 120 * greater than the number of existing repetitions. 121 */ 122 public NTE getNTE(int rep) { 123 NTE retVal = getTyped("NTE", rep, NTE.class); 124 return retVal; 125 } 126 127 /** 128 * Returns the number of existing repetitions of NTE 129 */ 130 public int getNTEReps() { 131 return getReps("NTE"); 132 } 133 134 /** 135 * <p> 136 * Returns a non-modifiable List containing all current existing repetitions of NTE. 137 * <p> 138 * <p> 139 * Note that unlike {@link #getNTE()}, this method will not create any reps 140 * if none are already present, so an empty list may be returned. 141 * </p> 142 */ 143 public List<NTE> getNTEAll() throws HL7Exception { 144 return getAllAsList("NTE", NTE.class); 145 } 146 147 /** 148 * Inserts a specific repetition of NTE (Notes and Comments) 149 * @see AbstractGroup#insertRepetition(Structure, int) 150 */ 151 public void insertNTE(NTE structure, int rep) throws HL7Exception { 152 super.insertRepetition("NTE", structure, rep); 153 } 154 155 156 /** 157 * Inserts a specific repetition of NTE (Notes and Comments) 158 * @see AbstractGroup#insertRepetition(Structure, int) 159 */ 160 public NTE insertNTE(int rep) throws HL7Exception { 161 return (NTE)super.insertRepetition("NTE", rep); 162 } 163 164 165 /** 166 * Removes a specific repetition of NTE (Notes and Comments) 167 * @see AbstractGroup#removeRepetition(String, int) 168 */ 169 public NTE removeNTE(int rep) throws HL7Exception { 170 return (NTE)super.removeRepetition("NTE", rep); 171 } 172 173 174 175 /** 176 * Returns 177 * the first repetition of 178 * ADJ (Adjustment) - creates it if necessary 179 */ 180 public ADJ getADJ() { 181 ADJ retVal = getTyped("ADJ", ADJ.class); 182 return retVal; 183 } 184 185 186 /** 187 * Returns a specific repetition of 188 * ADJ (Adjustment) - creates it if necessary 189 * 190 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 191 * @throws HL7Exception if the repetition requested is more than one 192 * greater than the number of existing repetitions. 193 */ 194 public ADJ getADJ(int rep) { 195 ADJ retVal = getTyped("ADJ", rep, ADJ.class); 196 return retVal; 197 } 198 199 /** 200 * Returns the number of existing repetitions of ADJ 201 */ 202 public int getADJReps() { 203 return getReps("ADJ"); 204 } 205 206 /** 207 * <p> 208 * Returns a non-modifiable List containing all current existing repetitions of ADJ. 209 * <p> 210 * <p> 211 * Note that unlike {@link #getADJ()}, this method will not create any reps 212 * if none are already present, so an empty list may be returned. 213 * </p> 214 */ 215 public List<ADJ> getADJAll() throws HL7Exception { 216 return getAllAsList("ADJ", ADJ.class); 217 } 218 219 /** 220 * Inserts a specific repetition of ADJ (Adjustment) 221 * @see AbstractGroup#insertRepetition(Structure, int) 222 */ 223 public void insertADJ(ADJ structure, int rep) throws HL7Exception { 224 super.insertRepetition("ADJ", structure, rep); 225 } 226 227 228 /** 229 * Inserts a specific repetition of ADJ (Adjustment) 230 * @see AbstractGroup#insertRepetition(Structure, int) 231 */ 232 public ADJ insertADJ(int rep) throws HL7Exception { 233 return (ADJ)super.insertRepetition("ADJ", rep); 234 } 235 236 237 /** 238 * Removes a specific repetition of ADJ (Adjustment) 239 * @see AbstractGroup#removeRepetition(String, int) 240 */ 241 public ADJ removeADJ(int rep) throws HL7Exception { 242 return (ADJ)super.removeRepetition("ADJ", rep); 243 } 244 245 246 247 /** 248 * Returns 249 * AUT (Authorization Information) - creates it if necessary 250 */ 251 public AUT getAUT() { 252 AUT retVal = getTyped("AUT", AUT.class); 253 return retVal; 254 } 255 256 257 258 259 /** 260 * Returns 261 * the first repetition of 262 * LOC (Location Identification) - creates it if necessary 263 */ 264 public LOC getLOC() { 265 LOC retVal = getTyped("LOC", LOC.class); 266 return retVal; 267 } 268 269 270 /** 271 * Returns a specific repetition of 272 * LOC (Location Identification) - creates it if necessary 273 * 274 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 275 * @throws HL7Exception if the repetition requested is more than one 276 * greater than the number of existing repetitions. 277 */ 278 public LOC getLOC(int rep) { 279 LOC retVal = getTyped("LOC", rep, LOC.class); 280 return retVal; 281 } 282 283 /** 284 * Returns the number of existing repetitions of LOC 285 */ 286 public int getLOCReps() { 287 return getReps("LOC"); 288 } 289 290 /** 291 * <p> 292 * Returns a non-modifiable List containing all current existing repetitions of LOC. 293 * <p> 294 * <p> 295 * Note that unlike {@link #getLOC()}, this method will not create any reps 296 * if none are already present, so an empty list may be returned. 297 * </p> 298 */ 299 public List<LOC> getLOCAll() throws HL7Exception { 300 return getAllAsList("LOC", LOC.class); 301 } 302 303 /** 304 * Inserts a specific repetition of LOC (Location Identification) 305 * @see AbstractGroup#insertRepetition(Structure, int) 306 */ 307 public void insertLOC(LOC structure, int rep) throws HL7Exception { 308 super.insertRepetition("LOC", structure, rep); 309 } 310 311 312 /** 313 * Inserts a specific repetition of LOC (Location Identification) 314 * @see AbstractGroup#insertRepetition(Structure, int) 315 */ 316 public LOC insertLOC(int rep) throws HL7Exception { 317 return (LOC)super.insertRepetition("LOC", rep); 318 } 319 320 321 /** 322 * Removes a specific repetition of LOC (Location Identification) 323 * @see AbstractGroup#removeRepetition(String, int) 324 */ 325 public LOC removeLOC(int rep) throws HL7Exception { 326 return (LOC)super.removeRepetition("LOC", rep); 327 } 328 329 330 331 /** 332 * Returns 333 * the first repetition of 334 * ROL (Role) - creates it if necessary 335 */ 336 public ROL getROL() { 337 ROL retVal = getTyped("ROL", ROL.class); 338 return retVal; 339 } 340 341 342 /** 343 * Returns a specific repetition of 344 * ROL (Role) - creates it if necessary 345 * 346 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 347 * @throws HL7Exception if the repetition requested is more than one 348 * greater than the number of existing repetitions. 349 */ 350 public ROL getROL(int rep) { 351 ROL retVal = getTyped("ROL", rep, ROL.class); 352 return retVal; 353 } 354 355 /** 356 * Returns the number of existing repetitions of ROL 357 */ 358 public int getROLReps() { 359 return getReps("ROL"); 360 } 361 362 /** 363 * <p> 364 * Returns a non-modifiable List containing all current existing repetitions of ROL. 365 * <p> 366 * <p> 367 * Note that unlike {@link #getROL()}, this method will not create any reps 368 * if none are already present, so an empty list may be returned. 369 * </p> 370 */ 371 public List<ROL> getROLAll() throws HL7Exception { 372 return getAllAsList("ROL", ROL.class); 373 } 374 375 /** 376 * Inserts a specific repetition of ROL (Role) 377 * @see AbstractGroup#insertRepetition(Structure, int) 378 */ 379 public void insertROL(ROL structure, int rep) throws HL7Exception { 380 super.insertRepetition("ROL", structure, rep); 381 } 382 383 384 /** 385 * Inserts a specific repetition of ROL (Role) 386 * @see AbstractGroup#insertRepetition(Structure, int) 387 */ 388 public ROL insertROL(int rep) throws HL7Exception { 389 return (ROL)super.insertRepetition("ROL", rep); 390 } 391 392 393 /** 394 * Removes a specific repetition of ROL (Role) 395 * @see AbstractGroup#removeRepetition(String, int) 396 */ 397 public ROL removeROL(int rep) throws HL7Exception { 398 return (ROL)super.removeRepetition("ROL", rep); 399 } 400 401 402 403} 404