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.v251.group; 035 036import ca.uhn.hl7v2.model.v251.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a SQR_S25_SCHEDULE 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: SCH (Scheduling Activity Information) <b> </b></li> 049 * <li>2: TQ1 (Timing/Quantity) <b>optional repeating </b></li> 050 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 051 * <li>4: SQR_S25_PATIENT (a Group object) <b>optional </b></li> 052 * <li>5: SQR_S25_RESOURCES (a Group object) <b> repeating </b></li> 053 * </ul> 054 */ 055//@SuppressWarnings("unused") 056public class SQR_S25_SCHEDULE extends AbstractGroup { 057 058 /** 059 * Creates a new SQR_S25_SCHEDULE group 060 */ 061 public SQR_S25_SCHEDULE(Group parent, ModelClassFactory factory) { 062 super(parent, factory); 063 init(factory); 064 } 065 066 private void init(ModelClassFactory factory) { 067 try { 068 this.add(SCH.class, true, false, false); 069 this.add(TQ1.class, false, true, false); 070 this.add(NTE.class, false, true, false); 071 this.add(SQR_S25_PATIENT.class, false, false, false); 072 this.add(SQR_S25_RESOURCES.class, true, true, false); 073 } catch(HL7Exception e) { 074 log.error("Unexpected error creating SQR_S25_SCHEDULE - this is probably a bug in the source code generator.", e); 075 } 076 } 077 078 /** 079 * Returns "2.5.1" 080 */ 081 public String getVersion() { 082 return "2.5.1"; 083 } 084 085 086 087 /** 088 * Returns 089 * SCH (Scheduling Activity Information) - creates it if necessary 090 */ 091 public SCH getSCH() { 092 SCH retVal = getTyped("SCH", SCH.class); 093 return retVal; 094 } 095 096 097 098 099 /** 100 * Returns 101 * the first repetition of 102 * TQ1 (Timing/Quantity) - creates it if necessary 103 */ 104 public TQ1 getTQ1() { 105 TQ1 retVal = getTyped("TQ1", TQ1.class); 106 return retVal; 107 } 108 109 110 /** 111 * Returns a specific repetition of 112 * TQ1 (Timing/Quantity) - creates it if necessary 113 * 114 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 115 * @throws HL7Exception if the repetition requested is more than one 116 * greater than the number of existing repetitions. 117 */ 118 public TQ1 getTQ1(int rep) { 119 TQ1 retVal = getTyped("TQ1", rep, TQ1.class); 120 return retVal; 121 } 122 123 /** 124 * Returns the number of existing repetitions of TQ1 125 */ 126 public int getTQ1Reps() { 127 return getReps("TQ1"); 128 } 129 130 /** 131 * <p> 132 * Returns a non-modifiable List containing all current existing repetitions of TQ1. 133 * <p> 134 * <p> 135 * Note that unlike {@link #getTQ1()}, this method will not create any reps 136 * if none are already present, so an empty list may be returned. 137 * </p> 138 */ 139 public java.util.List<TQ1> getTQ1All() throws HL7Exception { 140 return getAllAsList("TQ1", TQ1.class); 141 } 142 143 /** 144 * Inserts a specific repetition of TQ1 (Timing/Quantity) 145 * @see AbstractGroup#insertRepetition(Structure, int) 146 */ 147 public void insertTQ1(TQ1 structure, int rep) throws HL7Exception { 148 super.insertRepetition("TQ1", structure, rep); 149 } 150 151 152 /** 153 * Inserts a specific repetition of TQ1 (Timing/Quantity) 154 * @see AbstractGroup#insertRepetition(Structure, int) 155 */ 156 public TQ1 insertTQ1(int rep) throws HL7Exception { 157 return (TQ1)super.insertRepetition("TQ1", rep); 158 } 159 160 161 /** 162 * Removes a specific repetition of TQ1 (Timing/Quantity) 163 * @see AbstractGroup#removeRepetition(String, int) 164 */ 165 public TQ1 removeTQ1(int rep) throws HL7Exception { 166 return (TQ1)super.removeRepetition("TQ1", rep); 167 } 168 169 170 171 /** 172 * Returns 173 * the first repetition of 174 * NTE (Notes and Comments) - creates it if necessary 175 */ 176 public NTE getNTE() { 177 NTE retVal = getTyped("NTE", NTE.class); 178 return retVal; 179 } 180 181 182 /** 183 * Returns a specific repetition of 184 * NTE (Notes and Comments) - creates it if necessary 185 * 186 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 187 * @throws HL7Exception if the repetition requested is more than one 188 * greater than the number of existing repetitions. 189 */ 190 public NTE getNTE(int rep) { 191 NTE retVal = getTyped("NTE", rep, NTE.class); 192 return retVal; 193 } 194 195 /** 196 * Returns the number of existing repetitions of NTE 197 */ 198 public int getNTEReps() { 199 return getReps("NTE"); 200 } 201 202 /** 203 * <p> 204 * Returns a non-modifiable List containing all current existing repetitions of NTE. 205 * <p> 206 * <p> 207 * Note that unlike {@link #getNTE()}, this method will not create any reps 208 * if none are already present, so an empty list may be returned. 209 * </p> 210 */ 211 public java.util.List<NTE> getNTEAll() throws HL7Exception { 212 return getAllAsList("NTE", NTE.class); 213 } 214 215 /** 216 * Inserts a specific repetition of NTE (Notes and Comments) 217 * @see AbstractGroup#insertRepetition(Structure, int) 218 */ 219 public void insertNTE(NTE structure, int rep) throws HL7Exception { 220 super.insertRepetition("NTE", structure, rep); 221 } 222 223 224 /** 225 * Inserts a specific repetition of NTE (Notes and Comments) 226 * @see AbstractGroup#insertRepetition(Structure, int) 227 */ 228 public NTE insertNTE(int rep) throws HL7Exception { 229 return (NTE)super.insertRepetition("NTE", rep); 230 } 231 232 233 /** 234 * Removes a specific repetition of NTE (Notes and Comments) 235 * @see AbstractGroup#removeRepetition(String, int) 236 */ 237 public NTE removeNTE(int rep) throws HL7Exception { 238 return (NTE)super.removeRepetition("NTE", rep); 239 } 240 241 242 243 /** 244 * Returns 245 * PATIENT (a Group object) - creates it if necessary 246 */ 247 public SQR_S25_PATIENT getPATIENT() { 248 SQR_S25_PATIENT retVal = getTyped("PATIENT", SQR_S25_PATIENT.class); 249 return retVal; 250 } 251 252 253 254 255 /** 256 * Returns 257 * the first repetition of 258 * RESOURCES (a Group object) - creates it if necessary 259 */ 260 public SQR_S25_RESOURCES getRESOURCES() { 261 SQR_S25_RESOURCES retVal = getTyped("RESOURCES", SQR_S25_RESOURCES.class); 262 return retVal; 263 } 264 265 266 /** 267 * Returns a specific repetition of 268 * RESOURCES (a Group object) - creates it if necessary 269 * 270 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 271 * @throws HL7Exception if the repetition requested is more than one 272 * greater than the number of existing repetitions. 273 */ 274 public SQR_S25_RESOURCES getRESOURCES(int rep) { 275 SQR_S25_RESOURCES retVal = getTyped("RESOURCES", rep, SQR_S25_RESOURCES.class); 276 return retVal; 277 } 278 279 /** 280 * Returns the number of existing repetitions of RESOURCES 281 */ 282 public int getRESOURCESReps() { 283 return getReps("RESOURCES"); 284 } 285 286 /** 287 * <p> 288 * Returns a non-modifiable List containing all current existing repetitions of RESOURCES. 289 * <p> 290 * <p> 291 * Note that unlike {@link #getRESOURCES()}, this method will not create any reps 292 * if none are already present, so an empty list may be returned. 293 * </p> 294 */ 295 public java.util.List<SQR_S25_RESOURCES> getRESOURCESAll() throws HL7Exception { 296 return getAllAsList("RESOURCES", SQR_S25_RESOURCES.class); 297 } 298 299 /** 300 * Inserts a specific repetition of RESOURCES (a Group object) 301 * @see AbstractGroup#insertRepetition(Structure, int) 302 */ 303 public void insertRESOURCES(SQR_S25_RESOURCES structure, int rep) throws HL7Exception { 304 super.insertRepetition("RESOURCES", structure, rep); 305 } 306 307 308 /** 309 * Inserts a specific repetition of RESOURCES (a Group object) 310 * @see AbstractGroup#insertRepetition(Structure, int) 311 */ 312 public SQR_S25_RESOURCES insertRESOURCES(int rep) throws HL7Exception { 313 return (SQR_S25_RESOURCES)super.insertRepetition("RESOURCES", rep); 314 } 315 316 317 /** 318 * Removes a specific repetition of RESOURCES (a Group object) 319 * @see AbstractGroup#removeRepetition(String, int) 320 */ 321 public SQR_S25_RESOURCES removeRESOURCES(int rep) throws HL7Exception { 322 return (SQR_S25_RESOURCES)super.removeRepetition("RESOURCES", rep); 323 } 324 325 326 327} 328