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.v26.message; 035 036import ca.uhn.hl7v2.model.v26.group.*; 037import ca.uhn.hl7v2.model.v26.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 DOC_T12 message structure (see chapter 9.8.1). 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>optional </b> </li> 053 * <li>5: QRD (Original-Style Query Definition) <b> </b> </li> 054 * <li>6: DOC_T12_RESULT (a Group object) <b> repeating</b> </li> 055 * <li>7: DSC (Continuation Pointer) <b>optional </b> </li> 056 * </ul> 057 */ 058//@SuppressWarnings("unused") 059public class DOC_T12 extends AbstractMessage { 060 061 /** 062 * Creates a new DOC_T12 message with DefaultModelClassFactory. 063 */ 064 public DOC_T12() { 065 this(new DefaultModelClassFactory()); 066 } 067 068 /** 069 * Creates a new DOC_T12 message with custom ModelClassFactory. 070 */ 071 public DOC_T12(ModelClassFactory factory) { 072 super(factory); 073 init(factory); 074 } 075 076 private void init(ModelClassFactory factory) { 077 try { 078 this.add(MSH.class, true, false); 079 this.add(MSA.class, true, false); 080 this.add(ERR.class, false, false); 081 this.add(QAK.class, false, false); 082 this.add(QRD.class, true, false); 083 this.add(DOC_T12_RESULT.class, true, true); 084 this.add(DSC.class, false, false); 085 } catch(HL7Exception e) { 086 log.error("Unexpected error creating DOC_T12 - this is probably a bug in the source code generator.", e); 087 } 088 } 089 090 091 /** 092 * Returns "2.6" 093 */ 094 public String getVersion() { 095 return "2.6"; 096 } 097 098 099 100 101 /** 102 * <p> 103 * Returns 104 * MSH (Message Header) - creates it if necessary 105 * </p> 106 * 107 * 108 */ 109 public MSH getMSH() { 110 return getTyped("MSH", MSH.class); 111 } 112 113 114 115 116 117 /** 118 * <p> 119 * Returns 120 * MSA (Message Acknowledgment) - creates it if necessary 121 * </p> 122 * 123 * 124 */ 125 public MSA getMSA() { 126 return getTyped("MSA", MSA.class); 127 } 128 129 130 131 132 133 /** 134 * <p> 135 * Returns 136 * ERR (Error) - creates it if necessary 137 * </p> 138 * 139 * 140 */ 141 public ERR getERR() { 142 return getTyped("ERR", ERR.class); 143 } 144 145 146 147 148 149 /** 150 * <p> 151 * Returns 152 * QAK (Query Acknowledgment) - creates it if necessary 153 * </p> 154 * 155 * 156 */ 157 public QAK getQAK() { 158 return getTyped("QAK", QAK.class); 159 } 160 161 162 163 164 165 /** 166 * <p> 167 * Returns 168 * QRD (Original-Style Query Definition) - creates it if necessary 169 * </p> 170 * 171 * 172 */ 173 public QRD getQRD() { 174 return getTyped("QRD", QRD.class); 175 } 176 177 178 179 180 181 /** 182 * <p> 183 * Returns 184 * the first repetition of 185 * RESULT (a Group object) - creates it if necessary 186 * </p> 187 * 188 * 189 */ 190 public DOC_T12_RESULT getRESULT() { 191 return getTyped("RESULT", DOC_T12_RESULT.class); 192 } 193 194 195 /** 196 * <p> 197 * Returns a specific repetition of 198 * RESULT (a Group object) - creates it if necessary 199 * </p> 200 * 201 * 202 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 203 * @throws HL7Exception if the repetition requested is more than one 204 * greater than the number of existing repetitions. 205 */ 206 public DOC_T12_RESULT getRESULT(int rep) { 207 return getTyped("RESULT", rep, DOC_T12_RESULT.class); 208 } 209 210 /** 211 * <p> 212 * Returns the number of existing repetitions of RESULT 213 * </p> 214 * 215 */ 216 public int getRESULTReps() { 217 return getReps("RESULT"); 218 } 219 220 /** 221 * <p> 222 * Returns a non-modifiable List containing all current existing repetitions of RESULT. 223 * <p> 224 * <p> 225 * Note that unlike {@link #getRESULT()}, this method will not create any reps 226 * if none are already present, so an empty list may be returned. 227 * </p> 228 * 229 */ 230 public java.util.List<DOC_T12_RESULT> getRESULTAll() throws HL7Exception { 231 return getAllAsList("RESULT", DOC_T12_RESULT.class); 232 } 233 234 /** 235 * <p> 236 * Inserts a specific repetition of RESULT (a Group object) 237 * </p> 238 * 239 * 240 * @see AbstractGroup#insertRepetition(Structure, int) 241 */ 242 public void insertRESULT(DOC_T12_RESULT structure, int rep) throws HL7Exception { 243 super.insertRepetition( "RESULT", structure, rep); 244 } 245 246 247 /** 248 * <p> 249 * Inserts a specific repetition of RESULT (a Group object) 250 * </p> 251 * 252 * 253 * @see AbstractGroup#insertRepetition(Structure, int) 254 */ 255 public DOC_T12_RESULT insertRESULT(int rep) throws HL7Exception { 256 return (DOC_T12_RESULT)super.insertRepetition("RESULT", rep); 257 } 258 259 260 /** 261 * <p> 262 * Removes a specific repetition of RESULT (a Group object) 263 * </p> 264 * 265 * 266 * @see AbstractGroup#removeRepetition(String, int) 267 */ 268 public DOC_T12_RESULT removeRESULT(int rep) throws HL7Exception { 269 return (DOC_T12_RESULT)super.removeRepetition("RESULT", rep); 270 } 271 272 273 274 275 /** 276 * <p> 277 * Returns 278 * DSC (Continuation Pointer) - creates it if necessary 279 * </p> 280 * 281 * 282 */ 283 public DSC getDSC() { 284 return getTyped("DSC", DSC.class); 285 } 286 287 288 289 290} 291