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