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.v231.message; 035 036import ca.uhn.hl7v2.model.v231.group.*; 037import ca.uhn.hl7v2.model.v231.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 ORF_R04 message structure (see chapter ?). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (MSH - message header segment) <b> </b> </li> 050 * <li>2: MSA (MSA - message acknowledgment segment) <b> </b> </li> 051 * <li>3: QRD (QRD - original-style query definition segment) <b> </b> </li> 052 * <li>4: QRF (QRF - original style query filter segment) <b>optional </b> </li> 053 * <li>5: ORF_R04_PIDNTEORCOBRNTEOBXNTECTI (a Group object) <b> repeating</b> </li> 054 * <li>6: ERR (ERR - error segment) <b>optional </b> </li> 055 * <li>7: QAK (Query Acknowledgement) <b>optional </b> </li> 056 * <li>8: DSC (DSC - Continuation pointer segment) <b>optional </b> </li> 057 * </ul> 058 */ 059//@SuppressWarnings("unused") 060public class ORF_R04 extends AbstractMessage { 061 062 /** 063 * Creates a new ORF_R04 message with DefaultModelClassFactory. 064 */ 065 public ORF_R04() { 066 this(new DefaultModelClassFactory()); 067 } 068 069 /** 070 * Creates a new ORF_R04 message with custom ModelClassFactory. 071 */ 072 public ORF_R04(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(QRD.class, true, false); 082 this.add(QRF.class, false, false); 083 this.add(ORF_R04_PIDNTEORCOBRNTEOBXNTECTI.class, true, true); 084 this.add(ERR.class, false, false); 085 this.add(QAK.class, false, false); 086 this.add(DSC.class, false, false); 087 } catch(HL7Exception e) { 088 log.error("Unexpected error creating ORF_R04 - this is probably a bug in the source code generator.", e); 089 } 090 } 091 092 093 /** 094 * Returns "2.3.1" 095 */ 096 public String getVersion() { 097 return "2.3.1"; 098 } 099 100 101 102 103 /** 104 * <p> 105 * Returns 106 * MSH (MSH - message header segment) - 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 (MSA - message acknowledgment segment) - 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 * QRD (QRD - original-style query definition segment) - creates it if necessary 139 * </p> 140 * 141 * 142 */ 143 public QRD getQRD() { 144 return getTyped("QRD", QRD.class); 145 } 146 147 148 149 150 151 /** 152 * <p> 153 * Returns 154 * QRF (QRF - original style query filter segment) - creates it if necessary 155 * </p> 156 * 157 * 158 */ 159 public QRF getQRF() { 160 return getTyped("QRF", QRF.class); 161 } 162 163 164 165 166 167 /** 168 * <p> 169 * Returns 170 * the first repetition of 171 * PIDNTEORCOBRNTEOBXNTECTI (a Group object) - creates it if necessary 172 * </p> 173 * 174 * 175 */ 176 public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI getPIDNTEORCOBRNTEOBXNTECTI() { 177 return getTyped("PIDNTEORCOBRNTEOBXNTECTI", ORF_R04_PIDNTEORCOBRNTEOBXNTECTI.class); 178 } 179 180 181 /** 182 * <p> 183 * Returns a specific repetition of 184 * PIDNTEORCOBRNTEOBXNTECTI (a Group object) - creates it if necessary 185 * </p> 186 * 187 * 188 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 189 * @throws HL7Exception if the repetition requested is more than one 190 * greater than the number of existing repetitions. 191 */ 192 public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI getPIDNTEORCOBRNTEOBXNTECTI(int rep) { 193 return getTyped("PIDNTEORCOBRNTEOBXNTECTI", rep, ORF_R04_PIDNTEORCOBRNTEOBXNTECTI.class); 194 } 195 196 /** 197 * <p> 198 * Returns the number of existing repetitions of PIDNTEORCOBRNTEOBXNTECTI 199 * </p> 200 * 201 */ 202 public int getPIDNTEORCOBRNTEOBXNTECTIReps() { 203 return getReps("PIDNTEORCOBRNTEOBXNTECTI"); 204 } 205 206 /** 207 * <p> 208 * Returns a non-modifiable List containing all current existing repetitions of PIDNTEORCOBRNTEOBXNTECTI. 209 * <p> 210 * <p> 211 * Note that unlike {@link #getPIDNTEORCOBRNTEOBXNTECTI()}, this method will not create any reps 212 * if none are already present, so an empty list may be returned. 213 * </p> 214 * 215 */ 216 public java.util.List<ORF_R04_PIDNTEORCOBRNTEOBXNTECTI> getPIDNTEORCOBRNTEOBXNTECTIAll() throws HL7Exception { 217 return getAllAsList("PIDNTEORCOBRNTEOBXNTECTI", ORF_R04_PIDNTEORCOBRNTEOBXNTECTI.class); 218 } 219 220 /** 221 * <p> 222 * Inserts a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object) 223 * </p> 224 * 225 * 226 * @see AbstractGroup#insertRepetition(Structure, int) 227 */ 228 public void insertPIDNTEORCOBRNTEOBXNTECTI(ORF_R04_PIDNTEORCOBRNTEOBXNTECTI structure, int rep) throws HL7Exception { 229 super.insertRepetition( "PIDNTEORCOBRNTEOBXNTECTI", structure, rep); 230 } 231 232 233 /** 234 * <p> 235 * Inserts a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object) 236 * </p> 237 * 238 * 239 * @see AbstractGroup#insertRepetition(Structure, int) 240 */ 241 public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI insertPIDNTEORCOBRNTEOBXNTECTI(int rep) throws HL7Exception { 242 return (ORF_R04_PIDNTEORCOBRNTEOBXNTECTI)super.insertRepetition("PIDNTEORCOBRNTEOBXNTECTI", rep); 243 } 244 245 246 /** 247 * <p> 248 * Removes a specific repetition of PIDNTEORCOBRNTEOBXNTECTI (a Group object) 249 * </p> 250 * 251 * 252 * @see AbstractGroup#removeRepetition(String, int) 253 */ 254 public ORF_R04_PIDNTEORCOBRNTEOBXNTECTI removePIDNTEORCOBRNTEOBXNTECTI(int rep) throws HL7Exception { 255 return (ORF_R04_PIDNTEORCOBRNTEOBXNTECTI)super.removeRepetition("PIDNTEORCOBRNTEOBXNTECTI", rep); 256 } 257 258 259 260 261 /** 262 * <p> 263 * Returns 264 * ERR (ERR - error segment) - creates it if necessary 265 * </p> 266 * 267 * 268 */ 269 public ERR getERR() { 270 return getTyped("ERR", ERR.class); 271 } 272 273 274 275 276 277 /** 278 * <p> 279 * Returns 280 * QAK (Query Acknowledgement) - creates it if necessary 281 * </p> 282 * 283 * 284 */ 285 public QAK getQAK() { 286 return getTyped("QAK", QAK.class); 287 } 288 289 290 291 292 293 /** 294 * <p> 295 * Returns 296 * DSC (DSC - Continuation pointer segment) - 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