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 VXX_V02 message structure (see chapter 4.17.4). 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: SFT (Software Segment) <b>optional repeating</b> </li> 052 * <li>4: QRD (Original-Style Query Definition) <b> </b> </li> 053 * <li>5: QRF (Original style query filter) <b>optional </b> </li> 054 * <li>6: VXX_V02_PATIENT (a Group object) <b> repeating</b> </li> 055 * </ul> 056 */ 057//@SuppressWarnings("unused") 058public class VXX_V02 extends AbstractMessage { 059 060 /** 061 * Creates a new VXX_V02 message with DefaultModelClassFactory. 062 */ 063 public VXX_V02() { 064 this(new DefaultModelClassFactory()); 065 } 066 067 /** 068 * Creates a new VXX_V02 message with custom ModelClassFactory. 069 */ 070 public VXX_V02(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(SFT.class, false, true); 080 this.add(QRD.class, true, false); 081 this.add(QRF.class, false, false); 082 this.add(VXX_V02_PATIENT.class, true, true); 083 } catch(HL7Exception e) { 084 log.error("Unexpected error creating VXX_V02 - 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 * SFT (Software Segment) - creates it if necessary 136 * </p> 137 * 138 * 139 */ 140 public SFT getSFT() { 141 return getTyped("SFT", SFT.class); 142 } 143 144 145 /** 146 * <p> 147 * Returns a specific repetition of 148 * SFT (Software Segment) - 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 SFT getSFT(int rep) { 157 return getTyped("SFT", rep, SFT.class); 158 } 159 160 /** 161 * <p> 162 * Returns the number of existing repetitions of SFT 163 * </p> 164 * 165 */ 166 public int getSFTReps() { 167 return getReps("SFT"); 168 } 169 170 /** 171 * <p> 172 * Returns a non-modifiable List containing all current existing repetitions of SFT. 173 * <p> 174 * <p> 175 * Note that unlike {@link #getSFT()}, 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<SFT> getSFTAll() throws HL7Exception { 181 return getAllAsList("SFT", SFT.class); 182 } 183 184 /** 185 * <p> 186 * Inserts a specific repetition of SFT (Software Segment) 187 * </p> 188 * 189 * 190 * @see AbstractGroup#insertRepetition(Structure, int) 191 */ 192 public void insertSFT(SFT structure, int rep) throws HL7Exception { 193 super.insertRepetition( "SFT", structure, rep); 194 } 195 196 197 /** 198 * <p> 199 * Inserts a specific repetition of SFT (Software Segment) 200 * </p> 201 * 202 * 203 * @see AbstractGroup#insertRepetition(Structure, int) 204 */ 205 public SFT insertSFT(int rep) throws HL7Exception { 206 return (SFT)super.insertRepetition("SFT", rep); 207 } 208 209 210 /** 211 * <p> 212 * Removes a specific repetition of SFT (Software Segment) 213 * </p> 214 * 215 * 216 * @see AbstractGroup#removeRepetition(String, int) 217 */ 218 public SFT removeSFT(int rep) throws HL7Exception { 219 return (SFT)super.removeRepetition("SFT", rep); 220 } 221 222 223 224 225 /** 226 * <p> 227 * Returns 228 * QRD (Original-Style Query Definition) - creates it if necessary 229 * </p> 230 * 231 * 232 */ 233 public QRD getQRD() { 234 return getTyped("QRD", QRD.class); 235 } 236 237 238 239 240 241 /** 242 * <p> 243 * Returns 244 * QRF (Original style query filter) - creates it if necessary 245 * </p> 246 * 247 * 248 */ 249 public QRF getQRF() { 250 return getTyped("QRF", QRF.class); 251 } 252 253 254 255 256 257 /** 258 * <p> 259 * Returns 260 * the first repetition of 261 * PATIENT (a Group object) - creates it if necessary 262 * </p> 263 * 264 * 265 */ 266 public VXX_V02_PATIENT getPATIENT() { 267 return getTyped("PATIENT", VXX_V02_PATIENT.class); 268 } 269 270 271 /** 272 * <p> 273 * Returns a specific repetition of 274 * PATIENT (a Group object) - creates it if necessary 275 * </p> 276 * 277 * 278 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 279 * @throws HL7Exception if the repetition requested is more than one 280 * greater than the number of existing repetitions. 281 */ 282 public VXX_V02_PATIENT getPATIENT(int rep) { 283 return getTyped("PATIENT", rep, VXX_V02_PATIENT.class); 284 } 285 286 /** 287 * <p> 288 * Returns the number of existing repetitions of PATIENT 289 * </p> 290 * 291 */ 292 public int getPATIENTReps() { 293 return getReps("PATIENT"); 294 } 295 296 /** 297 * <p> 298 * Returns a non-modifiable List containing all current existing repetitions of PATIENT. 299 * <p> 300 * <p> 301 * Note that unlike {@link #getPATIENT()}, this method will not create any reps 302 * if none are already present, so an empty list may be returned. 303 * </p> 304 * 305 */ 306 public java.util.List<VXX_V02_PATIENT> getPATIENTAll() throws HL7Exception { 307 return getAllAsList("PATIENT", VXX_V02_PATIENT.class); 308 } 309 310 /** 311 * <p> 312 * Inserts a specific repetition of PATIENT (a Group object) 313 * </p> 314 * 315 * 316 * @see AbstractGroup#insertRepetition(Structure, int) 317 */ 318 public void insertPATIENT(VXX_V02_PATIENT structure, int rep) throws HL7Exception { 319 super.insertRepetition( "PATIENT", structure, rep); 320 } 321 322 323 /** 324 * <p> 325 * Inserts a specific repetition of PATIENT (a Group object) 326 * </p> 327 * 328 * 329 * @see AbstractGroup#insertRepetition(Structure, int) 330 */ 331 public VXX_V02_PATIENT insertPATIENT(int rep) throws HL7Exception { 332 return (VXX_V02_PATIENT)super.insertRepetition("PATIENT", rep); 333 } 334 335 336 /** 337 * <p> 338 * Removes a specific repetition of PATIENT (a Group object) 339 * </p> 340 * 341 * 342 * @see AbstractGroup#removeRepetition(String, int) 343 */ 344 public VXX_V02_PATIENT removePATIENT(int rep) throws HL7Exception { 345 return (VXX_V02_PATIENT)super.removeRepetition("PATIENT", rep); 346 } 347 348 349 350} 351