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.v24.message; 035 036import ca.uhn.hl7v2.model.v24.group.*; 037import ca.uhn.hl7v2.model.v24.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 RSP_Z88 message structure (see chapter 5). 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 </b> </li> 052 * <li>4: QAK (Query Acknowledgment) <b> </b> </li> 053 * <li>5: QPD (Query Parameter Definition) <b> </b> </li> 054 * <li>6: RCP (Response Control Parameter) <b> </b> </li> 055 * <li>7: RSP_Z88_QUERY_RESPONSE (a Group object) <b>optional repeating</b> </li> 056 * <li>8: DSC (Continuation Pointer) <b> </b> </li> 057 * </ul> 058 */ 059//@SuppressWarnings("unused") 060public class RSP_Z88 extends AbstractMessage { 061 062 /** 063 * Creates a new RSP_Z88 message with DefaultModelClassFactory. 064 */ 065 public RSP_Z88() { 066 this(new DefaultModelClassFactory()); 067 } 068 069 /** 070 * Creates a new RSP_Z88 message with custom ModelClassFactory. 071 */ 072 public RSP_Z88(ModelClassFactory factory) { 073 super(factory); 074 init(factory); 075 } 076 077 private void init(ModelClassFactory factory) { 078 try { 079 this.add(MSH.class, true, false); 080 this.add(MSA.class, true, false); 081 this.add(ERR.class, false, false); 082 this.add(QAK.class, true, false); 083 this.add(QPD.class, true, false); 084 this.add(RCP.class, true, false); 085 this.add(RSP_Z88_QUERY_RESPONSE.class, false, true); 086 this.add(DSC.class, true, false); 087 } catch(HL7Exception e) { 088 log.error("Unexpected error creating RSP_Z88 - this is probably a bug in the source code generator.", e); 089 } 090 } 091 092 093 /** 094 * Returns "2.4" 095 */ 096 public String getVersion() { 097 return "2.4"; 098 } 099 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 * QPD (Query Parameter Definition) - creates it if necessary 171 * </p> 172 * 173 * 174 */ 175 public QPD getQPD() { 176 return getTyped("QPD", QPD.class); 177 } 178 179 180 181 182 183 /** 184 * <p> 185 * Returns 186 * RCP (Response Control Parameter) - creates it if necessary 187 * </p> 188 * 189 * 190 */ 191 public RCP getRCP() { 192 return getTyped("RCP", RCP.class); 193 } 194 195 196 197 198 199 /** 200 * <p> 201 * Returns 202 * the first repetition of 203 * QUERY_RESPONSE (a Group object) - creates it if necessary 204 * </p> 205 * 206 * 207 */ 208 public RSP_Z88_QUERY_RESPONSE getQUERY_RESPONSE() { 209 return getTyped("QUERY_RESPONSE", RSP_Z88_QUERY_RESPONSE.class); 210 } 211 212 213 /** 214 * <p> 215 * Returns a specific repetition of 216 * QUERY_RESPONSE (a Group object) - 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 RSP_Z88_QUERY_RESPONSE getQUERY_RESPONSE(int rep) { 225 return getTyped("QUERY_RESPONSE", rep, RSP_Z88_QUERY_RESPONSE.class); 226 } 227 228 /** 229 * <p> 230 * Returns the number of existing repetitions of QUERY_RESPONSE 231 * </p> 232 * 233 */ 234 public int getQUERY_RESPONSEReps() { 235 return getReps("QUERY_RESPONSE"); 236 } 237 238 /** 239 * <p> 240 * Returns a non-modifiable List containing all current existing repetitions of QUERY_RESPONSE. 241 * <p> 242 * <p> 243 * Note that unlike {@link #getQUERY_RESPONSE()}, 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<RSP_Z88_QUERY_RESPONSE> getQUERY_RESPONSEAll() throws HL7Exception { 249 return getAllAsList("QUERY_RESPONSE", RSP_Z88_QUERY_RESPONSE.class); 250 } 251 252 /** 253 * <p> 254 * Inserts a specific repetition of QUERY_RESPONSE (a Group object) 255 * </p> 256 * 257 * 258 * @see AbstractGroup#insertRepetition(Structure, int) 259 */ 260 public void insertQUERY_RESPONSE(RSP_Z88_QUERY_RESPONSE structure, int rep) throws HL7Exception { 261 super.insertRepetition( "QUERY_RESPONSE", structure, rep); 262 } 263 264 265 /** 266 * <p> 267 * Inserts a specific repetition of QUERY_RESPONSE (a Group object) 268 * </p> 269 * 270 * 271 * @see AbstractGroup#insertRepetition(Structure, int) 272 */ 273 public RSP_Z88_QUERY_RESPONSE insertQUERY_RESPONSE(int rep) throws HL7Exception { 274 return (RSP_Z88_QUERY_RESPONSE)super.insertRepetition("QUERY_RESPONSE", rep); 275 } 276 277 278 /** 279 * <p> 280 * Removes a specific repetition of QUERY_RESPONSE (a Group object) 281 * </p> 282 * 283 * 284 * @see AbstractGroup#removeRepetition(String, int) 285 */ 286 public RSP_Z88_QUERY_RESPONSE removeQUERY_RESPONSE(int rep) throws HL7Exception { 287 return (RSP_Z88_QUERY_RESPONSE)super.removeRepetition("QUERY_RESPONSE", 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