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 TBR_R08 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> </b> </li> 51 * <li>3: ERR (Error) <b>optional </b> </li> 52 * <li>4: QAK (Query Acknowledgment) <b> </b> </li> 53 * <li>5: RDF (Table Row Definition) <b> </b> </li> 54 * <li>6: RDT (Table Row Data) <b> repeating</b> </li> 55 * <li>7: DSC (Continuation Pointer) <b>optional </b> </li> 56 * </ul> 57 */ 58 //@SuppressWarnings("unused") 59 public class TBR_R08 extends AbstractMessage { 60 61 /** 62 * Creates a new TBR_R08 message with DefaultModelClassFactory. 63 */ 64 public TBR_R08() { 65 this(new DefaultModelClassFactory()); 66 } 67 68 /** 69 * Creates a new TBR_R08 message with custom ModelClassFactory. 70 */ 71 public TBR_R08(ModelClassFactory factory) { 72 super(factory); 73 init(factory); 74 } 75 76 private void init(ModelClassFactory factory) { 77 try { 78 this.add(MSH.class, true, false); 79 this.add(MSA.class, true, false); 80 this.add(ERR.class, false, false); 81 this.add(QAK.class, true, false); 82 this.add(RDF.class, true, false); 83 this.add(RDT.class, true, true); 84 this.add(DSC.class, false, false); 85 } catch(HL7Exception e) { 86 log.error("Unexpected error creating TBR_R08 - this is probably a bug in the source code generator.", e); 87 } 88 } 89 90 91 /** 92 * Returns "2.4" 93 */ 94 public String getVersion() { 95 return "2.4"; 96 } 97 98 99 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 * RDF (Table Row Definition) - creates it if necessary 169 * </p> 170 * 171 * 172 */ 173 public RDF getRDF() { 174 return getTyped("RDF", RDF.class); 175 } 176 177 178 179 180 181 /** 182 * <p> 183 * Returns 184 * the first repetition of 185 * RDT (Table Row Data) - creates it if necessary 186 * </p> 187 * 188 * 189 */ 190 public RDT getRDT() { 191 return getTyped("RDT", RDT.class); 192 } 193 194 195 /** 196 * <p> 197 * Returns a specific repetition of 198 * RDT (Table Row Data) - 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 RDT getRDT(int rep) { 207 return getTyped("RDT", rep, RDT.class); 208 } 209 210 /** 211 * <p> 212 * Returns the number of existing repetitions of RDT 213 * </p> 214 * 215 */ 216 public int getRDTReps() { 217 return getReps("RDT"); 218 } 219 220 /** 221 * <p> 222 * Returns a non-modifiable List containing all current existing repetitions of RDT. 223 * <p> 224 * <p> 225 * Note that unlike {@link #getRDT()}, 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<RDT> getRDTAll() throws HL7Exception { 231 return getAllAsList("RDT", RDT.class); 232 } 233 234 /** 235 * <p> 236 * Inserts a specific repetition of RDT (Table Row Data) 237 * </p> 238 * 239 * 240 * @see AbstractGroup#insertRepetition(Structure, int) 241 */ 242 public void insertRDT(RDT structure, int rep) throws HL7Exception { 243 super.insertRepetition( "RDT", structure, rep); 244 } 245 246 247 /** 248 * <p> 249 * Inserts a specific repetition of RDT (Table Row Data) 250 * </p> 251 * 252 * 253 * @see AbstractGroup#insertRepetition(Structure, int) 254 */ 255 public RDT insertRDT(int rep) throws HL7Exception { 256 return (RDT)super.insertRepetition("RDT", rep); 257 } 258 259 260 /** 261 * <p> 262 * Removes a specific repetition of RDT (Table Row Data) 263 * </p> 264 * 265 * 266 * @see AbstractGroup#removeRepetition(String, int) 267 */ 268 public RDT removeRDT(int rep) throws HL7Exception { 269 return (RDT)super.removeRepetition("RDT", 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