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.v24.message; 35 36 import ca.uhn.hl7v2.model.v24.group.*; 37 import ca.uhn.hl7v2.model.v24.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 DSR_Q03 message structure (see chapter ?). 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>optional </b> </li> 51 * <li>3: ERR (Error) <b>optional </b> </li> 52 * <li>4: QAK (Query Acknowledgment) <b>optional </b> </li> 53 * <li>5: QRD (Original-Style Query Definition) <b> </b> </li> 54 * <li>6: QRF (Original Style Query Filter) <b>optional </b> </li> 55 * <li>7: DSP (Display Data) <b> repeating</b> </li> 56 * <li>8: DSC (Continuation Pointer) <b>optional </b> </li> 57 * </ul> 58 */ 59 //@SuppressWarnings("unused") 60 public class DSR_Q03 extends AbstractMessage { 61 62 /** 63 * Creates a new DSR_Q03 message with DefaultModelClassFactory. 64 */ 65 public DSR_Q03() { 66 this(new DefaultModelClassFactory()); 67 } 68 69 /** 70 * Creates a new DSR_Q03 message with custom ModelClassFactory. 71 */ 72 public DSR_Q03(ModelClassFactory factory) { 73 super(factory); 74 init(factory); 75 } 76 77 private void init(ModelClassFactory factory) { 78 try { 79 this.add(MSH.class, true, false); 80 this.add(MSA.class, false, false); 81 this.add(ERR.class, false, false); 82 this.add(QAK.class, false, false); 83 this.add(QRD.class, true, false); 84 this.add(QRF.class, false, false); 85 this.add(DSP.class, true, true); 86 this.add(DSC.class, false, false); 87 } catch(HL7Exception e) { 88 log.error("Unexpected error creating DSR_Q03 - this is probably a bug in the source code generator.", e); 89 } 90 } 91 92 93 /** 94 * Returns "2.4" 95 */ 96 public String getVersion() { 97 return "2.4"; 98 } 99 100 101 102 103 /** 104 * <p> 105 * Returns 106 * MSH (Message Header) - creates it if necessary 107 * </p> 108 * 109 * 110 */ 111 public MSH getMSH() { 112 return getTyped("MSH", MSH.class); 113 } 114 115 116 117 118 119 /** 120 * <p> 121 * Returns 122 * MSA (Message Acknowledgment) - creates it if necessary 123 * </p> 124 * 125 * 126 */ 127 public MSA getMSA() { 128 return getTyped("MSA", MSA.class); 129 } 130 131 132 133 134 135 /** 136 * <p> 137 * Returns 138 * ERR (Error) - creates it if necessary 139 * </p> 140 * 141 * 142 */ 143 public ERR getERR() { 144 return getTyped("ERR", ERR.class); 145 } 146 147 148 149 150 151 /** 152 * <p> 153 * Returns 154 * QAK (Query Acknowledgment) - creates it if necessary 155 * </p> 156 * 157 * 158 */ 159 public QAK getQAK() { 160 return getTyped("QAK", QAK.class); 161 } 162 163 164 165 166 167 /** 168 * <p> 169 * Returns 170 * QRD (Original-Style Query Definition) - creates it if necessary 171 * </p> 172 * 173 * 174 */ 175 public QRD getQRD() { 176 return getTyped("QRD", QRD.class); 177 } 178 179 180 181 182 183 /** 184 * <p> 185 * Returns 186 * QRF (Original Style Query Filter) - creates it if necessary 187 * </p> 188 * 189 * 190 */ 191 public QRF getQRF() { 192 return getTyped("QRF", QRF.class); 193 } 194 195 196 197 198 199 /** 200 * <p> 201 * Returns 202 * the first repetition of 203 * DSP (Display Data) - creates it if necessary 204 * </p> 205 * 206 * 207 */ 208 public DSP getDSP() { 209 return getTyped("DSP", DSP.class); 210 } 211 212 213 /** 214 * <p> 215 * Returns a specific repetition of 216 * DSP (Display Data) - creates it if necessary 217 * </p> 218 * 219 * 220 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 221 * @throws HL7Exception if the repetition requested is more than one 222 * greater than the number of existing repetitions. 223 */ 224 public DSP getDSP(int rep) { 225 return getTyped("DSP", rep, DSP.class); 226 } 227 228 /** 229 * <p> 230 * Returns the number of existing repetitions of DSP 231 * </p> 232 * 233 */ 234 public int getDSPReps() { 235 return getReps("DSP"); 236 } 237 238 /** 239 * <p> 240 * Returns a non-modifiable List containing all current existing repetitions of DSP. 241 * <p> 242 * <p> 243 * Note that unlike {@link #getDSP()}, this method will not create any reps 244 * if none are already present, so an empty list may be returned. 245 * </p> 246 * 247 */ 248 public java.util.List<DSP> getDSPAll() throws HL7Exception { 249 return getAllAsList("DSP", DSP.class); 250 } 251 252 /** 253 * <p> 254 * Inserts a specific repetition of DSP (Display Data) 255 * </p> 256 * 257 * 258 * @see AbstractGroup#insertRepetition(Structure, int) 259 */ 260 public void insertDSP(DSP structure, int rep) throws HL7Exception { 261 super.insertRepetition( "DSP", structure, rep); 262 } 263 264 265 /** 266 * <p> 267 * Inserts a specific repetition of DSP (Display Data) 268 * </p> 269 * 270 * 271 * @see AbstractGroup#insertRepetition(Structure, int) 272 */ 273 public DSP insertDSP(int rep) throws HL7Exception { 274 return (DSP)super.insertRepetition("DSP", rep); 275 } 276 277 278 /** 279 * <p> 280 * Removes a specific repetition of DSP (Display Data) 281 * </p> 282 * 283 * 284 * @see AbstractGroup#removeRepetition(String, int) 285 */ 286 public DSP removeDSP(int rep) throws HL7Exception { 287 return (DSP)super.removeRepetition("DSP", rep); 288 } 289 290 291 292 293 /** 294 * <p> 295 * Returns 296 * DSC (Continuation Pointer) - creates it if necessary 297 * </p> 298 * 299 * 300 */ 301 public DSC getDSC() { 302 return getTyped("DSC", DSC.class); 303 } 304 305 306 307 308 } 309