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.message; 035 036import ca.uhn.hl7v2.model.v25.group.*; 037import ca.uhn.hl7v2.model.v25.segment.*; 038 039import ca.uhn.hl7v2.HL7Exception; 040import ca.uhn.hl7v2.parser.ModelClassFactory; 041import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044 045/** 046 * <p>Represents a SQR_S25 message structure (see chapter 10.5.3). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message Header) <b> </b> </li> 050 * <li>2: MSA (Message Acknowledgment) <b> </b> </li> 051 * <li>3: ERR (Error) <b>optional repeating</b> </li> 052 * <li>4: QAK (Query Acknowledgment) <b> </b> </li> 053 * <li>5: SQR_S25_SCHEDULE (a Group object) <b>optional repeating</b> </li> 054 * <li>6: DSC (Continuation Pointer) <b>optional </b> </li> 055 * </ul> 056 */ 057//@SuppressWarnings("unused") 058public class SQR_S25 extends AbstractMessage { 059 060 /** 061 * Creates a new SQR_S25 message with DefaultModelClassFactory. 062 */ 063 public SQR_S25() { 064 this(new DefaultModelClassFactory()); 065 } 066 067 /** 068 * Creates a new SQR_S25 message with custom ModelClassFactory. 069 */ 070 public SQR_S25(ModelClassFactory factory) { 071 super(factory); 072 init(factory); 073 } 074 075 private void init(ModelClassFactory factory) { 076 try { 077 this.add(MSH.class, true, false); 078 this.add(MSA.class, true, false); 079 this.add(ERR.class, false, true); 080 this.add(QAK.class, true, false); 081 this.add(SQR_S25_SCHEDULE.class, false, true); 082 this.add(DSC.class, false, false); 083 } catch(HL7Exception e) { 084 log.error("Unexpected error creating SQR_S25 - this is probably a bug in the source code generator.", e); 085 } 086 } 087 088 089 /** 090 * Returns "2.5" 091 */ 092 public String getVersion() { 093 return "2.5"; 094 } 095 096 097 098 099 /** 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 * MSA (Message Acknowledgment) - creates it if necessary 119 * </p> 120 * 121 * 122 */ 123 public MSA getMSA() { 124 return getTyped("MSA", MSA.class); 125 } 126 127 128 129 130 131 /** 132 * <p> 133 * Returns 134 * the first repetition of 135 * ERR (Error) - creates it if necessary 136 * </p> 137 * 138 * 139 */ 140 public ERR getERR() { 141 return getTyped("ERR", ERR.class); 142 } 143 144 145 /** 146 * <p> 147 * Returns a specific repetition of 148 * ERR (Error) - creates it if necessary 149 * </p> 150 * 151 * 152 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 153 * @throws HL7Exception if the repetition requested is more than one 154 * greater than the number of existing repetitions. 155 */ 156 public ERR getERR(int rep) { 157 return getTyped("ERR", rep, ERR.class); 158 } 159 160 /** 161 * <p> 162 * Returns the number of existing repetitions of ERR 163 * </p> 164 * 165 */ 166 public int getERRReps() { 167 return getReps("ERR"); 168 } 169 170 /** 171 * <p> 172 * Returns a non-modifiable List containing all current existing repetitions of ERR. 173 * <p> 174 * <p> 175 * Note that unlike {@link #getERR()}, this method will not create any reps 176 * if none are already present, so an empty list may be returned. 177 * </p> 178 * 179 */ 180 public java.util.List<ERR> getERRAll() throws HL7Exception { 181 return getAllAsList("ERR", ERR.class); 182 } 183 184 /** 185 * <p> 186 * Inserts a specific repetition of ERR (Error) 187 * </p> 188 * 189 * 190 * @see AbstractGroup#insertRepetition(Structure, int) 191 */ 192 public void insertERR(ERR structure, int rep) throws HL7Exception { 193 super.insertRepetition( "ERR", structure, rep); 194 } 195 196 197 /** 198 * <p> 199 * Inserts a specific repetition of ERR (Error) 200 * </p> 201 * 202 * 203 * @see AbstractGroup#insertRepetition(Structure, int) 204 */ 205 public ERR insertERR(int rep) throws HL7Exception { 206 return (ERR)super.insertRepetition("ERR", rep); 207 } 208 209 210 /** 211 * <p> 212 * Removes a specific repetition of ERR (Error) 213 * </p> 214 * 215 * 216 * @see AbstractGroup#removeRepetition(String, int) 217 */ 218 public ERR removeERR(int rep) throws HL7Exception { 219 return (ERR)super.removeRepetition("ERR", rep); 220 } 221 222 223 224 225 /** 226 * <p> 227 * Returns 228 * QAK (Query Acknowledgment) - creates it if necessary 229 * </p> 230 * 231 * 232 */ 233 public QAK getQAK() { 234 return getTyped("QAK", QAK.class); 235 } 236 237 238 239 240 241 /** 242 * <p> 243 * Returns 244 * the first repetition of 245 * SCHEDULE (a Group object) - creates it if necessary 246 * </p> 247 * 248 * 249 */ 250 public SQR_S25_SCHEDULE getSCHEDULE() { 251 return getTyped("SCHEDULE", SQR_S25_SCHEDULE.class); 252 } 253 254 255 /** 256 * <p> 257 * Returns a specific repetition of 258 * SCHEDULE (a Group object) - creates it if necessary 259 * </p> 260 * 261 * 262 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 263 * @throws HL7Exception if the repetition requested is more than one 264 * greater than the number of existing repetitions. 265 */ 266 public SQR_S25_SCHEDULE getSCHEDULE(int rep) { 267 return getTyped("SCHEDULE", rep, SQR_S25_SCHEDULE.class); 268 } 269 270 /** 271 * <p> 272 * Returns the number of existing repetitions of SCHEDULE 273 * </p> 274 * 275 */ 276 public int getSCHEDULEReps() { 277 return getReps("SCHEDULE"); 278 } 279 280 /** 281 * <p> 282 * Returns a non-modifiable List containing all current existing repetitions of SCHEDULE. 283 * <p> 284 * <p> 285 * Note that unlike {@link #getSCHEDULE()}, this method will not create any reps 286 * if none are already present, so an empty list may be returned. 287 * </p> 288 * 289 */ 290 public java.util.List<SQR_S25_SCHEDULE> getSCHEDULEAll() throws HL7Exception { 291 return getAllAsList("SCHEDULE", SQR_S25_SCHEDULE.class); 292 } 293 294 /** 295 * <p> 296 * Inserts a specific repetition of SCHEDULE (a Group object) 297 * </p> 298 * 299 * 300 * @see AbstractGroup#insertRepetition(Structure, int) 301 */ 302 public void insertSCHEDULE(SQR_S25_SCHEDULE structure, int rep) throws HL7Exception { 303 super.insertRepetition( "SCHEDULE", structure, rep); 304 } 305 306 307 /** 308 * <p> 309 * Inserts a specific repetition of SCHEDULE (a Group object) 310 * </p> 311 * 312 * 313 * @see AbstractGroup#insertRepetition(Structure, int) 314 */ 315 public SQR_S25_SCHEDULE insertSCHEDULE(int rep) throws HL7Exception { 316 return (SQR_S25_SCHEDULE)super.insertRepetition("SCHEDULE", rep); 317 } 318 319 320 /** 321 * <p> 322 * Removes a specific repetition of SCHEDULE (a Group object) 323 * </p> 324 * 325 * 326 * @see AbstractGroup#removeRepetition(String, int) 327 */ 328 public SQR_S25_SCHEDULE removeSCHEDULE(int rep) throws HL7Exception { 329 return (SQR_S25_SCHEDULE)super.removeRepetition("SCHEDULE", rep); 330 } 331 332 333 334 335 /** 336 * <p> 337 * Returns 338 * DSC (Continuation Pointer) - creates it if necessary 339 * </p> 340 * 341 * 342 */ 343 public DSC getDSC() { 344 return getTyped("DSC", DSC.class); 345 } 346 347 348 349 350} 351