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.v22.message; 35 36 import ca.uhn.hl7v2.model.v22.group.*; 37 import ca.uhn.hl7v2.model.v22.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: QRD (QUERY DEFINITION) <b> </b> </li> 52 * <li>4: QRF (QUERY FILTER) <b>optional </b> </li> 53 * <li>5: DSP (DISPLAY DATA) <b> repeating</b> </li> 54 * <li>6: DSC (CONTINUATION POINTER) <b> </b> </li> 55 * </ul> 56 */ 57 //@SuppressWarnings("unused") 58 public class DSR_Q03 extends AbstractMessage { 59 60 /** 61 * Creates a new DSR_Q03 message with DefaultModelClassFactory. 62 */ 63 public DSR_Q03() { 64 this(new DefaultModelClassFactory()); 65 } 66 67 /** 68 * Creates a new DSR_Q03 message with custom ModelClassFactory. 69 */ 70 public DSR_Q03(ModelClassFactory factory) { 71 super(factory); 72 init(factory); 73 } 74 75 private void init(ModelClassFactory factory) { 76 try { 77 this.add(MSH.class, true, false); 78 this.add(MSA.class, false, false); 79 this.add(QRD.class, true, false); 80 this.add(QRF.class, false, false); 81 this.add(DSP.class, true, true); 82 this.add(DSC.class, true, false); 83 } catch(HL7Exception e) { 84 log.error("Unexpected error creating DSR_Q03 - this is probably a bug in the source code generator.", e); 85 } 86 } 87 88 89 /** 90 * Returns "2.2" 91 */ 92 public String getVersion() { 93 return "2.2"; 94 } 95 96 97 98 99 /** 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 * QRD (QUERY DEFINITION) - creates it if necessary 135 * </p> 136 * 137 * 138 */ 139 public QRD getQRD() { 140 return getTyped("QRD", QRD.class); 141 } 142 143 144 145 146 147 /** 148 * <p> 149 * Returns 150 * QRF (QUERY FILTER) - creates it if necessary 151 * </p> 152 * 153 * 154 */ 155 public QRF getQRF() { 156 return getTyped("QRF", QRF.class); 157 } 158 159 160 161 162 163 /** 164 * <p> 165 * Returns 166 * the first repetition of 167 * DSP (DISPLAY DATA) - creates it if necessary 168 * </p> 169 * 170 * 171 */ 172 public DSP getDSP() { 173 return getTyped("DSP", DSP.class); 174 } 175 176 177 /** 178 * <p> 179 * Returns a specific repetition of 180 * DSP (DISPLAY DATA) - creates it if necessary 181 * </p> 182 * 183 * 184 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 185 * @throws HL7Exception if the repetition requested is more than one 186 * greater than the number of existing repetitions. 187 */ 188 public DSP getDSP(int rep) { 189 return getTyped("DSP", rep, DSP.class); 190 } 191 192 /** 193 * <p> 194 * Returns the number of existing repetitions of DSP 195 * </p> 196 * 197 */ 198 public int getDSPReps() { 199 return getReps("DSP"); 200 } 201 202 /** 203 * <p> 204 * Returns a non-modifiable List containing all current existing repetitions of DSP. 205 * <p> 206 * <p> 207 * Note that unlike {@link #getDSP()}, this method will not create any reps 208 * if none are already present, so an empty list may be returned. 209 * </p> 210 * 211 */ 212 public java.util.List<DSP> getDSPAll() throws HL7Exception { 213 return getAllAsList("DSP", DSP.class); 214 } 215 216 /** 217 * <p> 218 * Inserts a specific repetition of DSP (DISPLAY DATA) 219 * </p> 220 * 221 * 222 * @see AbstractGroup#insertRepetition(Structure, int) 223 */ 224 public void insertDSP(DSP structure, int rep) throws HL7Exception { 225 super.insertRepetition( "DSP", structure, rep); 226 } 227 228 229 /** 230 * <p> 231 * Inserts a specific repetition of DSP (DISPLAY DATA) 232 * </p> 233 * 234 * 235 * @see AbstractGroup#insertRepetition(Structure, int) 236 */ 237 public DSP insertDSP(int rep) throws HL7Exception { 238 return (DSP)super.insertRepetition("DSP", rep); 239 } 240 241 242 /** 243 * <p> 244 * Removes a specific repetition of DSP (DISPLAY DATA) 245 * </p> 246 * 247 * 248 * @see AbstractGroup#removeRepetition(String, int) 249 */ 250 public DSP removeDSP(int rep) throws HL7Exception { 251 return (DSP)super.removeRepetition("DSP", rep); 252 } 253 254 255 256 257 /** 258 * <p> 259 * Returns 260 * DSC (CONTINUATION POINTER) - creates it if necessary 261 * </p> 262 * 263 * 264 */ 265 public DSC getDSC() { 266 return getTyped("DSC", DSC.class); 267 } 268 269 270 271 272 } 273