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.v25.group; 035 036import ca.uhn.hl7v2.model.v25.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a RAS_O17_ORDER group structure (a Group object). 044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 045 * This Group contains the following elements: 046 * </p> 047 * <ul> 048 * <li>1: ORC (Common Order) <b> </b></li> 049 * <li>2: RAS_O17_TIMING (a Group object) <b>optional repeating </b></li> 050 * <li>3: RAS_O17_ORDER_DETAIL (a Group object) <b>optional </b></li> 051 * <li>4: RAS_O17_ENCODING (a Group object) <b>optional </b></li> 052 * <li>5: RAS_O17_ADMINISTRATION (a Group object) <b> repeating </b></li> 053 * <li>6: CTI (Clinical Trial Identification) <b>optional repeating </b></li> 054 * </ul> 055 */ 056//@SuppressWarnings("unused") 057public class RAS_O17_ORDER extends AbstractGroup { 058 059 /** 060 * Creates a new RAS_O17_ORDER group 061 */ 062 public RAS_O17_ORDER(Group parent, ModelClassFactory factory) { 063 super(parent, factory); 064 init(factory); 065 } 066 067 private void init(ModelClassFactory factory) { 068 try { 069 this.add(ORC.class, true, false, false); 070 this.add(RAS_O17_TIMING.class, false, true, false); 071 this.add(RAS_O17_ORDER_DETAIL.class, false, false, false); 072 this.add(RAS_O17_ENCODING.class, false, false, false); 073 this.add(RAS_O17_ADMINISTRATION.class, true, true, false); 074 this.add(CTI.class, false, true, false); 075 } catch(HL7Exception e) { 076 log.error("Unexpected error creating RAS_O17_ORDER - this is probably a bug in the source code generator.", e); 077 } 078 } 079 080 /** 081 * Returns "2.5" 082 */ 083 public String getVersion() { 084 return "2.5"; 085 } 086 087 088 089 /** 090 * Returns 091 * ORC (Common Order) - creates it if necessary 092 */ 093 public ORC getORC() { 094 ORC retVal = getTyped("ORC", ORC.class); 095 return retVal; 096 } 097 098 099 100 101 /** 102 * Returns 103 * the first repetition of 104 * TIMING (a Group object) - creates it if necessary 105 */ 106 public RAS_O17_TIMING getTIMING() { 107 RAS_O17_TIMING retVal = getTyped("TIMING", RAS_O17_TIMING.class); 108 return retVal; 109 } 110 111 112 /** 113 * Returns a specific repetition of 114 * TIMING (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 RAS_O17_TIMING getTIMING(int rep) { 121 RAS_O17_TIMING retVal = getTyped("TIMING", rep, RAS_O17_TIMING.class); 122 return retVal; 123 } 124 125 /** 126 * Returns the number of existing repetitions of TIMING 127 */ 128 public int getTIMINGReps() { 129 return getReps("TIMING"); 130 } 131 132 /** 133 * <p> 134 * Returns a non-modifiable List containing all current existing repetitions of TIMING. 135 * <p> 136 * <p> 137 * Note that unlike {@link #getTIMING()}, 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 java.util.List<RAS_O17_TIMING> getTIMINGAll() throws HL7Exception { 142 return getAllAsList("TIMING", RAS_O17_TIMING.class); 143 } 144 145 /** 146 * Inserts a specific repetition of TIMING (a Group object) 147 * @see AbstractGroup#insertRepetition(Structure, int) 148 */ 149 public void insertTIMING(RAS_O17_TIMING structure, int rep) throws HL7Exception { 150 super.insertRepetition("TIMING", structure, rep); 151 } 152 153 154 /** 155 * Inserts a specific repetition of TIMING (a Group object) 156 * @see AbstractGroup#insertRepetition(Structure, int) 157 */ 158 public RAS_O17_TIMING insertTIMING(int rep) throws HL7Exception { 159 return (RAS_O17_TIMING)super.insertRepetition("TIMING", rep); 160 } 161 162 163 /** 164 * Removes a specific repetition of TIMING (a Group object) 165 * @see AbstractGroup#removeRepetition(String, int) 166 */ 167 public RAS_O17_TIMING removeTIMING(int rep) throws HL7Exception { 168 return (RAS_O17_TIMING)super.removeRepetition("TIMING", rep); 169 } 170 171 172 173 /** 174 * Returns 175 * ORDER_DETAIL (a Group object) - creates it if necessary 176 */ 177 public RAS_O17_ORDER_DETAIL getORDER_DETAIL() { 178 RAS_O17_ORDER_DETAIL retVal = getTyped("ORDER_DETAIL", RAS_O17_ORDER_DETAIL.class); 179 return retVal; 180 } 181 182 183 184 185 /** 186 * Returns 187 * ENCODING (a Group object) - creates it if necessary 188 */ 189 public RAS_O17_ENCODING getENCODING() { 190 RAS_O17_ENCODING retVal = getTyped("ENCODING", RAS_O17_ENCODING.class); 191 return retVal; 192 } 193 194 195 196 197 /** 198 * Returns 199 * the first repetition of 200 * ADMINISTRATION (a Group object) - creates it if necessary 201 */ 202 public RAS_O17_ADMINISTRATION getADMINISTRATION() { 203 RAS_O17_ADMINISTRATION retVal = getTyped("ADMINISTRATION", RAS_O17_ADMINISTRATION.class); 204 return retVal; 205 } 206 207 208 /** 209 * Returns a specific repetition of 210 * ADMINISTRATION (a Group object) - creates it if necessary 211 * 212 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 213 * @throws HL7Exception if the repetition requested is more than one 214 * greater than the number of existing repetitions. 215 */ 216 public RAS_O17_ADMINISTRATION getADMINISTRATION(int rep) { 217 RAS_O17_ADMINISTRATION retVal = getTyped("ADMINISTRATION", rep, RAS_O17_ADMINISTRATION.class); 218 return retVal; 219 } 220 221 /** 222 * Returns the number of existing repetitions of ADMINISTRATION 223 */ 224 public int getADMINISTRATIONReps() { 225 return getReps("ADMINISTRATION"); 226 } 227 228 /** 229 * <p> 230 * Returns a non-modifiable List containing all current existing repetitions of ADMINISTRATION. 231 * <p> 232 * <p> 233 * Note that unlike {@link #getADMINISTRATION()}, this method will not create any reps 234 * if none are already present, so an empty list may be returned. 235 * </p> 236 */ 237 public java.util.List<RAS_O17_ADMINISTRATION> getADMINISTRATIONAll() throws HL7Exception { 238 return getAllAsList("ADMINISTRATION", RAS_O17_ADMINISTRATION.class); 239 } 240 241 /** 242 * Inserts a specific repetition of ADMINISTRATION (a Group object) 243 * @see AbstractGroup#insertRepetition(Structure, int) 244 */ 245 public void insertADMINISTRATION(RAS_O17_ADMINISTRATION structure, int rep) throws HL7Exception { 246 super.insertRepetition("ADMINISTRATION", structure, rep); 247 } 248 249 250 /** 251 * Inserts a specific repetition of ADMINISTRATION (a Group object) 252 * @see AbstractGroup#insertRepetition(Structure, int) 253 */ 254 public RAS_O17_ADMINISTRATION insertADMINISTRATION(int rep) throws HL7Exception { 255 return (RAS_O17_ADMINISTRATION)super.insertRepetition("ADMINISTRATION", rep); 256 } 257 258 259 /** 260 * Removes a specific repetition of ADMINISTRATION (a Group object) 261 * @see AbstractGroup#removeRepetition(String, int) 262 */ 263 public RAS_O17_ADMINISTRATION removeADMINISTRATION(int rep) throws HL7Exception { 264 return (RAS_O17_ADMINISTRATION)super.removeRepetition("ADMINISTRATION", rep); 265 } 266 267 268 269 /** 270 * Returns 271 * the first repetition of 272 * CTI (Clinical Trial Identification) - creates it if necessary 273 */ 274 public CTI getCTI() { 275 CTI retVal = getTyped("CTI", CTI.class); 276 return retVal; 277 } 278 279 280 /** 281 * Returns a specific repetition of 282 * CTI (Clinical Trial Identification) - creates it if necessary 283 * 284 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 285 * @throws HL7Exception if the repetition requested is more than one 286 * greater than the number of existing repetitions. 287 */ 288 public CTI getCTI(int rep) { 289 CTI retVal = getTyped("CTI", rep, CTI.class); 290 return retVal; 291 } 292 293 /** 294 * Returns the number of existing repetitions of CTI 295 */ 296 public int getCTIReps() { 297 return getReps("CTI"); 298 } 299 300 /** 301 * <p> 302 * Returns a non-modifiable List containing all current existing repetitions of CTI. 303 * <p> 304 * <p> 305 * Note that unlike {@link #getCTI()}, this method will not create any reps 306 * if none are already present, so an empty list may be returned. 307 * </p> 308 */ 309 public java.util.List<CTI> getCTIAll() throws HL7Exception { 310 return getAllAsList("CTI", CTI.class); 311 } 312 313 /** 314 * Inserts a specific repetition of CTI (Clinical Trial Identification) 315 * @see AbstractGroup#insertRepetition(Structure, int) 316 */ 317 public void insertCTI(CTI structure, int rep) throws HL7Exception { 318 super.insertRepetition("CTI", structure, rep); 319 } 320 321 322 /** 323 * Inserts a specific repetition of CTI (Clinical Trial Identification) 324 * @see AbstractGroup#insertRepetition(Structure, int) 325 */ 326 public CTI insertCTI(int rep) throws HL7Exception { 327 return (CTI)super.insertRepetition("CTI", rep); 328 } 329 330 331 /** 332 * Removes a specific repetition of CTI (Clinical Trial Identification) 333 * @see AbstractGroup#removeRepetition(String, int) 334 */ 335 public CTI removeCTI(int rep) throws HL7Exception { 336 return (CTI)super.removeRepetition("CTI", rep); 337 } 338 339 340 341} 342