1 /* 2 * This class is an auto-generated source file for a HAPI 3 * HL7 v2.x standard structure class. 4 * 5 * For more information, visit: http://hl7api.sourceforge.net/ 6 * 7 * The contents of this file are subject to the Mozilla Public License Version 1.1 8 * (the "License"); you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 12 * specific language governing rights and limitations under the License. 13 * 14 * The Original Code is "[file_name]". Description: 15 * "[one_line_description]" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2012. All Rights Reserved. 19 * 20 * Contributor(s): ______________________________________. 21 * 22 * Alternatively, the contents of this file may be used under the terms of the 23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 24 * applicable instead of those above. If you wish to allow use of your version of this 25 * file only under the terms of the GPL and not to allow others to use your version 26 * of this file under the MPL, indicate your decision by deleting the provisions above 27 * and replace them with the notice and other provisions required by the GPL License. 28 * If you do not delete the provisions above, a recipient may use your version of 29 * this file under either the MPL or the GPL. 30 * 31 */ 32 33 34 package ca.uhn.hl7v2.model.v25.message; 35 36 import ca.uhn.hl7v2.model.v25.group.*; 37 import ca.uhn.hl7v2.model.v25.segment.*; 38 39 import ca.uhn.hl7v2.HL7Exception; 40 import ca.uhn.hl7v2.parser.ModelClassFactory; 41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 42 import ca.uhn.hl7v2.model.*; 43 44 45 /** 46 * <p>Represents a ORR_O02 message structure (see chapter 4.4.2). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (Message Header) <b> </b> </li> 50 * <li>2: MSA (Message Acknowledgment) <b> </b> </li> 51 * <li>3: ERR (Error) <b>optional repeating</b> </li> 52 * <li>4: NTE (Notes and Comments) <b>optional repeating</b> </li> 53 * <li>5: ORR_O02_RESPONSE (a Group object) <b>optional </b> </li> 54 * </ul> 55 */ 56 //@SuppressWarnings("unused") 57 public class ORR_O02 extends AbstractMessage { 58 59 /** 60 * Creates a new ORR_O02 message with DefaultModelClassFactory. 61 */ 62 public ORR_O02() { 63 this(new DefaultModelClassFactory()); 64 } 65 66 /** 67 * Creates a new ORR_O02 message with custom ModelClassFactory. 68 */ 69 public ORR_O02(ModelClassFactory factory) { 70 super(factory); 71 init(factory); 72 } 73 74 private void init(ModelClassFactory factory) { 75 try { 76 this.add(MSH.class, true, false); 77 this.add(MSA.class, true, false); 78 this.add(ERR.class, false, true); 79 this.add(NTE.class, false, true); 80 this.add(ORR_O02_RESPONSE.class, false, false); 81 } catch(HL7Exception e) { 82 log.error("Unexpected error creating ORR_O02 - this is probably a bug in the source code generator.", e); 83 } 84 } 85 86 87 /** 88 * Returns "2.5" 89 */ 90 public String getVersion() { 91 return "2.5"; 92 } 93 94 95 96 97 /** 98 * <p> 99 * Returns 100 * MSH (Message Header) - creates it if necessary 101 * </p> 102 * 103 * 104 */ 105 public MSH getMSH() { 106 return getTyped("MSH", MSH.class); 107 } 108 109 110 111 112 113 /** 114 * <p> 115 * Returns 116 * MSA (Message Acknowledgment) - creates it if necessary 117 * </p> 118 * 119 * 120 */ 121 public MSA getMSA() { 122 return getTyped("MSA", MSA.class); 123 } 124 125 126 127 128 129 /** 130 * <p> 131 * Returns 132 * the first repetition of 133 * ERR (Error) - creates it if necessary 134 * </p> 135 * 136 * 137 */ 138 public ERR getERR() { 139 return getTyped("ERR", ERR.class); 140 } 141 142 143 /** 144 * <p> 145 * Returns a specific repetition of 146 * ERR (Error) - creates it if necessary 147 * </p> 148 * 149 * 150 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 151 * @throws HL7Exception if the repetition requested is more than one 152 * greater than the number of existing repetitions. 153 */ 154 public ERR getERR(int rep) { 155 return getTyped("ERR", rep, ERR.class); 156 } 157 158 /** 159 * <p> 160 * Returns the number of existing repetitions of ERR 161 * </p> 162 * 163 */ 164 public int getERRReps() { 165 return getReps("ERR"); 166 } 167 168 /** 169 * <p> 170 * Returns a non-modifiable List containing all current existing repetitions of ERR. 171 * <p> 172 * <p> 173 * Note that unlike {@link #getERR()}, this method will not create any reps 174 * if none are already present, so an empty list may be returned. 175 * </p> 176 * 177 */ 178 public java.util.List<ERR> getERRAll() throws HL7Exception { 179 return getAllAsList("ERR", ERR.class); 180 } 181 182 /** 183 * <p> 184 * Inserts a specific repetition of ERR (Error) 185 * </p> 186 * 187 * 188 * @see AbstractGroup#insertRepetition(Structure, int) 189 */ 190 public void insertERR(ERR structure, int rep) throws HL7Exception { 191 super.insertRepetition( "ERR", structure, rep); 192 } 193 194 195 /** 196 * <p> 197 * Inserts a specific repetition of ERR (Error) 198 * </p> 199 * 200 * 201 * @see AbstractGroup#insertRepetition(Structure, int) 202 */ 203 public ERR insertERR(int rep) throws HL7Exception { 204 return (ERR)super.insertRepetition("ERR", rep); 205 } 206 207 208 /** 209 * <p> 210 * Removes a specific repetition of ERR (Error) 211 * </p> 212 * 213 * 214 * @see AbstractGroup#removeRepetition(String, int) 215 */ 216 public ERR removeERR(int rep) throws HL7Exception { 217 return (ERR)super.removeRepetition("ERR", rep); 218 } 219 220 221 222 223 /** 224 * <p> 225 * Returns 226 * the first repetition of 227 * NTE (Notes and Comments) - creates it if necessary 228 * </p> 229 * 230 * 231 */ 232 public NTE getNTE() { 233 return getTyped("NTE", NTE.class); 234 } 235 236 237 /** 238 * <p> 239 * Returns a specific repetition of 240 * NTE (Notes and Comments) - creates it if necessary 241 * </p> 242 * 243 * 244 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 245 * @throws HL7Exception if the repetition requested is more than one 246 * greater than the number of existing repetitions. 247 */ 248 public NTE getNTE(int rep) { 249 return getTyped("NTE", rep, NTE.class); 250 } 251 252 /** 253 * <p> 254 * Returns the number of existing repetitions of NTE 255 * </p> 256 * 257 */ 258 public int getNTEReps() { 259 return getReps("NTE"); 260 } 261 262 /** 263 * <p> 264 * Returns a non-modifiable List containing all current existing repetitions of NTE. 265 * <p> 266 * <p> 267 * Note that unlike {@link #getNTE()}, this method will not create any reps 268 * if none are already present, so an empty list may be returned. 269 * </p> 270 * 271 */ 272 public java.util.List<NTE> getNTEAll() throws HL7Exception { 273 return getAllAsList("NTE", NTE.class); 274 } 275 276 /** 277 * <p> 278 * Inserts a specific repetition of NTE (Notes and Comments) 279 * </p> 280 * 281 * 282 * @see AbstractGroup#insertRepetition(Structure, int) 283 */ 284 public void insertNTE(NTE structure, int rep) throws HL7Exception { 285 super.insertRepetition( "NTE", structure, rep); 286 } 287 288 289 /** 290 * <p> 291 * Inserts a specific repetition of NTE (Notes and Comments) 292 * </p> 293 * 294 * 295 * @see AbstractGroup#insertRepetition(Structure, int) 296 */ 297 public NTE insertNTE(int rep) throws HL7Exception { 298 return (NTE)super.insertRepetition("NTE", rep); 299 } 300 301 302 /** 303 * <p> 304 * Removes a specific repetition of NTE (Notes and Comments) 305 * </p> 306 * 307 * 308 * @see AbstractGroup#removeRepetition(String, int) 309 */ 310 public NTE removeNTE(int rep) throws HL7Exception { 311 return (NTE)super.removeRepetition("NTE", rep); 312 } 313 314 315 316 317 /** 318 * <p> 319 * Returns 320 * RESPONSE (a Group object) - creates it if necessary 321 * </p> 322 * 323 * 324 */ 325 public ORR_O02_RESPONSE getRESPONSE() { 326 return getTyped("RESPONSE", ORR_O02_RESPONSE.class); 327 } 328 329 330 331 332 } 333