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.v23.group; 035 036import ca.uhn.hl7v2.model.v23.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 SIU_S21_RESOURCES 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: RGS (Resource Group) <b> </b></li> 051 * <li>2: SIU_S21_SERVICE (a Group object) <b>optional repeating</b></li> 052 * <li>3: SIU_S21_GENERAL_RESOURCE (a Group object) <b>optional repeating</b></li> 053 * <li>4: SIU_S21_LOCATION_RESOURCE (a Group object) <b>optional repeating</b></li> 054 * <li>5: SIU_S21_PERSONNEL_RESOURCE (a Group object) <b>optional repeating</b></li> 055 * </ul> 056 */ 057@SuppressWarnings("unused") 058public class SIU_S21_RESOURCES extends AbstractGroup { 059 060 /** 061 * Creates a new SIU_S21_RESOURCES group 062 */ 063 public SIU_S21_RESOURCES(Group parent, ModelClassFactory factory) { 064 super(parent, factory); 065 init(factory); 066 } 067 068 private void init(ModelClassFactory factory) { 069 try { 070 this.add(RGS.class, true, false); 071 this.add(SIU_S21_SERVICE.class, false, true); 072 this.add(SIU_S21_GENERAL_RESOURCE.class, false, true); 073 this.add(SIU_S21_LOCATION_RESOURCE.class, false, true); 074 this.add(SIU_S21_PERSONNEL_RESOURCE.class, false, true); 075 } catch(HL7Exception e) { 076 log.error("Unexpected error creating SIU_S21_RESOURCES - this is probably a bug in the source code generator.", e); 077 } 078 } 079 080 /** 081 * Returns "2.3" 082 */ 083 public String getVersion() { 084 return "2.3"; 085 } 086 087 088 089 /** 090 * Returns 091 * RGS (Resource Group) - creates it if necessary 092 */ 093 public RGS getRGS() { 094 RGS retVal = getTyped("RGS", RGS.class); 095 return retVal; 096 } 097 098 099 100 101 /** 102 * Returns 103 * the first repetition of 104 * SERVICE (a Group object) - creates it if necessary 105 */ 106 public SIU_S21_SERVICE getSERVICE() { 107 SIU_S21_SERVICE retVal = getTyped("SERVICE", SIU_S21_SERVICE.class); 108 return retVal; 109 } 110 111 112 /** 113 * Returns a specific repetition of 114 * SERVICE (a Group object) - creates it if necessary 115 * 116 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 117 * @throws HL7Exception if the repetition requested is more than one 118 * greater than the number of existing repetitions. 119 */ 120 public SIU_S21_SERVICE getSERVICE(int rep) { 121 SIU_S21_SERVICE retVal = getTyped("SERVICE", rep, SIU_S21_SERVICE.class); 122 return retVal; 123 } 124 125 /** 126 * Returns the number of existing repetitions of SERVICE 127 */ 128 public int getSERVICEReps() { 129 return getReps("SERVICE"); 130 } 131 132 /** 133 * <p> 134 * Returns a non-modifiable List containing all current existing repetitions of SERVICE. 135 * <p> 136 * <p> 137 * Note that unlike {@link #getSERVICE()}, this method will not create any reps 138 * if none are already present, so an empty list may be returned. 139 * </p> 140 */ 141 public List<SIU_S21_SERVICE> getSERVICEAll() throws HL7Exception { 142 return getAllAsList("SERVICE", SIU_S21_SERVICE.class); 143 } 144 145 /** 146 * Inserts a specific repetition of SERVICE (a Group object) 147 * @see AbstractGroup#insertRepetition(Structure, int) 148 */ 149 public void insertSERVICE(SIU_S21_SERVICE structure, int rep) throws HL7Exception { 150 super.insertRepetition("SERVICE", structure, rep); 151 } 152 153 154 /** 155 * Inserts a specific repetition of SERVICE (a Group object) 156 * @see AbstractGroup#insertRepetition(Structure, int) 157 */ 158 public SIU_S21_SERVICE insertSERVICE(int rep) throws HL7Exception { 159 return (SIU_S21_SERVICE)super.insertRepetition("SERVICE", rep); 160 } 161 162 163 /** 164 * Removes a specific repetition of SERVICE (a Group object) 165 * @see AbstractGroup#removeRepetition(String, int) 166 */ 167 public SIU_S21_SERVICE removeSERVICE(int rep) throws HL7Exception { 168 return (SIU_S21_SERVICE)super.removeRepetition("SERVICE", rep); 169 } 170 171 172 173 /** 174 * Returns 175 * the first repetition of 176 * GENERAL_RESOURCE (a Group object) - creates it if necessary 177 */ 178 public SIU_S21_GENERAL_RESOURCE getGENERAL_RESOURCE() { 179 SIU_S21_GENERAL_RESOURCE retVal = getTyped("GENERAL_RESOURCE", SIU_S21_GENERAL_RESOURCE.class); 180 return retVal; 181 } 182 183 184 /** 185 * Returns a specific repetition of 186 * GENERAL_RESOURCE (a Group object) - creates it if necessary 187 * 188 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 189 * @throws HL7Exception if the repetition requested is more than one 190 * greater than the number of existing repetitions. 191 */ 192 public SIU_S21_GENERAL_RESOURCE getGENERAL_RESOURCE(int rep) { 193 SIU_S21_GENERAL_RESOURCE retVal = getTyped("GENERAL_RESOURCE", rep, SIU_S21_GENERAL_RESOURCE.class); 194 return retVal; 195 } 196 197 /** 198 * Returns the number of existing repetitions of GENERAL_RESOURCE 199 */ 200 public int getGENERAL_RESOURCEReps() { 201 return getReps("GENERAL_RESOURCE"); 202 } 203 204 /** 205 * <p> 206 * Returns a non-modifiable List containing all current existing repetitions of GENERAL_RESOURCE. 207 * <p> 208 * <p> 209 * Note that unlike {@link #getGENERAL_RESOURCE()}, this method will not create any reps 210 * if none are already present, so an empty list may be returned. 211 * </p> 212 */ 213 public List<SIU_S21_GENERAL_RESOURCE> getGENERAL_RESOURCEAll() throws HL7Exception { 214 return getAllAsList("GENERAL_RESOURCE", SIU_S21_GENERAL_RESOURCE.class); 215 } 216 217 /** 218 * Inserts a specific repetition of GENERAL_RESOURCE (a Group object) 219 * @see AbstractGroup#insertRepetition(Structure, int) 220 */ 221 public void insertGENERAL_RESOURCE(SIU_S21_GENERAL_RESOURCE structure, int rep) throws HL7Exception { 222 super.insertRepetition("GENERAL_RESOURCE", structure, rep); 223 } 224 225 226 /** 227 * Inserts a specific repetition of GENERAL_RESOURCE (a Group object) 228 * @see AbstractGroup#insertRepetition(Structure, int) 229 */ 230 public SIU_S21_GENERAL_RESOURCE insertGENERAL_RESOURCE(int rep) throws HL7Exception { 231 return (SIU_S21_GENERAL_RESOURCE)super.insertRepetition("GENERAL_RESOURCE", rep); 232 } 233 234 235 /** 236 * Removes a specific repetition of GENERAL_RESOURCE (a Group object) 237 * @see AbstractGroup#removeRepetition(String, int) 238 */ 239 public SIU_S21_GENERAL_RESOURCE removeGENERAL_RESOURCE(int rep) throws HL7Exception { 240 return (SIU_S21_GENERAL_RESOURCE)super.removeRepetition("GENERAL_RESOURCE", rep); 241 } 242 243 244 245 /** 246 * Returns 247 * the first repetition of 248 * LOCATION_RESOURCE (a Group object) - creates it if necessary 249 */ 250 public SIU_S21_LOCATION_RESOURCE getLOCATION_RESOURCE() { 251 SIU_S21_LOCATION_RESOURCE retVal = getTyped("LOCATION_RESOURCE", SIU_S21_LOCATION_RESOURCE.class); 252 return retVal; 253 } 254 255 256 /** 257 * Returns a specific repetition of 258 * LOCATION_RESOURCE (a Group object) - creates it if necessary 259 * 260 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 261 * @throws HL7Exception if the repetition requested is more than one 262 * greater than the number of existing repetitions. 263 */ 264 public SIU_S21_LOCATION_RESOURCE getLOCATION_RESOURCE(int rep) { 265 SIU_S21_LOCATION_RESOURCE retVal = getTyped("LOCATION_RESOURCE", rep, SIU_S21_LOCATION_RESOURCE.class); 266 return retVal; 267 } 268 269 /** 270 * Returns the number of existing repetitions of LOCATION_RESOURCE 271 */ 272 public int getLOCATION_RESOURCEReps() { 273 return getReps("LOCATION_RESOURCE"); 274 } 275 276 /** 277 * <p> 278 * Returns a non-modifiable List containing all current existing repetitions of LOCATION_RESOURCE. 279 * <p> 280 * <p> 281 * Note that unlike {@link #getLOCATION_RESOURCE()}, this method will not create any reps 282 * if none are already present, so an empty list may be returned. 283 * </p> 284 */ 285 public List<SIU_S21_LOCATION_RESOURCE> getLOCATION_RESOURCEAll() throws HL7Exception { 286 return getAllAsList("LOCATION_RESOURCE", SIU_S21_LOCATION_RESOURCE.class); 287 } 288 289 /** 290 * Inserts a specific repetition of LOCATION_RESOURCE (a Group object) 291 * @see AbstractGroup#insertRepetition(Structure, int) 292 */ 293 public void insertLOCATION_RESOURCE(SIU_S21_LOCATION_RESOURCE structure, int rep) throws HL7Exception { 294 super.insertRepetition("LOCATION_RESOURCE", structure, rep); 295 } 296 297 298 /** 299 * Inserts a specific repetition of LOCATION_RESOURCE (a Group object) 300 * @see AbstractGroup#insertRepetition(Structure, int) 301 */ 302 public SIU_S21_LOCATION_RESOURCE insertLOCATION_RESOURCE(int rep) throws HL7Exception { 303 return (SIU_S21_LOCATION_RESOURCE)super.insertRepetition("LOCATION_RESOURCE", rep); 304 } 305 306 307 /** 308 * Removes a specific repetition of LOCATION_RESOURCE (a Group object) 309 * @see AbstractGroup#removeRepetition(String, int) 310 */ 311 public SIU_S21_LOCATION_RESOURCE removeLOCATION_RESOURCE(int rep) throws HL7Exception { 312 return (SIU_S21_LOCATION_RESOURCE)super.removeRepetition("LOCATION_RESOURCE", rep); 313 } 314 315 316 317 /** 318 * Returns 319 * the first repetition of 320 * PERSONNEL_RESOURCE (a Group object) - creates it if necessary 321 */ 322 public SIU_S21_PERSONNEL_RESOURCE getPERSONNEL_RESOURCE() { 323 SIU_S21_PERSONNEL_RESOURCE retVal = getTyped("PERSONNEL_RESOURCE", SIU_S21_PERSONNEL_RESOURCE.class); 324 return retVal; 325 } 326 327 328 /** 329 * Returns a specific repetition of 330 * PERSONNEL_RESOURCE (a Group object) - creates it if necessary 331 * 332 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 333 * @throws HL7Exception if the repetition requested is more than one 334 * greater than the number of existing repetitions. 335 */ 336 public SIU_S21_PERSONNEL_RESOURCE getPERSONNEL_RESOURCE(int rep) { 337 SIU_S21_PERSONNEL_RESOURCE retVal = getTyped("PERSONNEL_RESOURCE", rep, SIU_S21_PERSONNEL_RESOURCE.class); 338 return retVal; 339 } 340 341 /** 342 * Returns the number of existing repetitions of PERSONNEL_RESOURCE 343 */ 344 public int getPERSONNEL_RESOURCEReps() { 345 return getReps("PERSONNEL_RESOURCE"); 346 } 347 348 /** 349 * <p> 350 * Returns a non-modifiable List containing all current existing repetitions of PERSONNEL_RESOURCE. 351 * <p> 352 * <p> 353 * Note that unlike {@link #getPERSONNEL_RESOURCE()}, this method will not create any reps 354 * if none are already present, so an empty list may be returned. 355 * </p> 356 */ 357 public List<SIU_S21_PERSONNEL_RESOURCE> getPERSONNEL_RESOURCEAll() throws HL7Exception { 358 return getAllAsList("PERSONNEL_RESOURCE", SIU_S21_PERSONNEL_RESOURCE.class); 359 } 360 361 /** 362 * Inserts a specific repetition of PERSONNEL_RESOURCE (a Group object) 363 * @see AbstractGroup#insertRepetition(Structure, int) 364 */ 365 public void insertPERSONNEL_RESOURCE(SIU_S21_PERSONNEL_RESOURCE structure, int rep) throws HL7Exception { 366 super.insertRepetition("PERSONNEL_RESOURCE", structure, rep); 367 } 368 369 370 /** 371 * Inserts a specific repetition of PERSONNEL_RESOURCE (a Group object) 372 * @see AbstractGroup#insertRepetition(Structure, int) 373 */ 374 public SIU_S21_PERSONNEL_RESOURCE insertPERSONNEL_RESOURCE(int rep) throws HL7Exception { 375 return (SIU_S21_PERSONNEL_RESOURCE)super.insertRepetition("PERSONNEL_RESOURCE", rep); 376 } 377 378 379 /** 380 * Removes a specific repetition of PERSONNEL_RESOURCE (a Group object) 381 * @see AbstractGroup#removeRepetition(String, int) 382 */ 383 public SIU_S21_PERSONNEL_RESOURCE removePERSONNEL_RESOURCE(int rep) throws HL7Exception { 384 return (SIU_S21_PERSONNEL_RESOURCE)super.removeRepetition("PERSONNEL_RESOURCE", rep); 385 } 386 387 388 389} 390