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.v23.message; 035 036import ca.uhn.hl7v2.model.v23.group.*; 037import ca.uhn.hl7v2.model.v23.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 MFK_M01 message structure (see chapter ?). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message header segment) <b> </b> </li> 050 * <li>2: MSA (Message acknowledgement segment) <b> </b> </li> 051 * <li>3: MFI (Master file identification segment) <b> </b> </li> 052 * <li>4: ERR (Error segment) <b>optional </b> </li> 053 * <li>5: MFA (Master file acknowledgement segment) <b>optional repeating</b> </li> 054 * <li>6: MFI (Master file identification segment) <b> </b> </li> 055 * <li>7: MFK_M01_MF (a Group object) <b> repeating</b> </li> 056 * </ul> 057 */ 058//@SuppressWarnings("unused") 059public class MFK_M01 extends AbstractMessage { 060 061 /** 062 * Creates a new MFK_M01 message with DefaultModelClassFactory. 063 */ 064 public MFK_M01() { 065 this(new DefaultModelClassFactory()); 066 } 067 068 /** 069 * Creates a new MFK_M01 message with custom ModelClassFactory. 070 */ 071 public MFK_M01(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(MFI.class, true, false); 081 this.add(ERR.class, false, false); 082 this.add(MFA.class, false, true); 083 this.add(MFI.class, true, false); 084 this.add(MFK_M01_MF.class, true, true); 085 } catch(HL7Exception e) { 086 log.error("Unexpected error creating MFK_M01 - this is probably a bug in the source code generator.", e); 087 } 088 } 089 090 091 /** 092 * Returns "2.3" 093 */ 094 public String getVersion() { 095 return "2.3"; 096 } 097 098 099 100 101 /** 102 * <p> 103 * Returns 104 * MSH (Message header segment) - 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 acknowledgement segment) - 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 * MFI (Master file identification segment) - creates it if necessary 137 * </p> 138 * 139 * 140 */ 141 public MFI getMFI() { 142 return getTyped("MFI", MFI.class); 143 } 144 145 146 147 148 149 /** 150 * <p> 151 * Returns 152 * ERR (Error segment) - creates it if necessary 153 * </p> 154 * 155 * 156 */ 157 public ERR getERR() { 158 return getTyped("ERR", ERR.class); 159 } 160 161 162 163 164 165 /** 166 * <p> 167 * Returns 168 * the first repetition of 169 * MFA (Master file acknowledgement segment) - creates it if necessary 170 * </p> 171 * 172 * 173 */ 174 public MFA getMFA() { 175 return getTyped("MFA", MFA.class); 176 } 177 178 179 /** 180 * <p> 181 * Returns a specific repetition of 182 * MFA (Master file acknowledgement segment) - creates it if necessary 183 * </p> 184 * 185 * 186 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 187 * @throws HL7Exception if the repetition requested is more than one 188 * greater than the number of existing repetitions. 189 */ 190 public MFA getMFA(int rep) { 191 return getTyped("MFA", rep, MFA.class); 192 } 193 194 /** 195 * <p> 196 * Returns the number of existing repetitions of MFA 197 * </p> 198 * 199 */ 200 public int getMFAReps() { 201 return getReps("MFA"); 202 } 203 204 /** 205 * <p> 206 * Returns a non-modifiable List containing all current existing repetitions of MFA. 207 * <p> 208 * <p> 209 * Note that unlike {@link #getMFA()}, this method will not create any reps 210 * if none are already present, so an empty list may be returned. 211 * </p> 212 * 213 */ 214 public java.util.List<MFA> getMFAAll() throws HL7Exception { 215 return getAllAsList("MFA", MFA.class); 216 } 217 218 /** 219 * <p> 220 * Inserts a specific repetition of MFA (Master file acknowledgement segment) 221 * </p> 222 * 223 * 224 * @see AbstractGroup#insertRepetition(Structure, int) 225 */ 226 public void insertMFA(MFA structure, int rep) throws HL7Exception { 227 super.insertRepetition( "MFA", structure, rep); 228 } 229 230 231 /** 232 * <p> 233 * Inserts a specific repetition of MFA (Master file acknowledgement segment) 234 * </p> 235 * 236 * 237 * @see AbstractGroup#insertRepetition(Structure, int) 238 */ 239 public MFA insertMFA(int rep) throws HL7Exception { 240 return (MFA)super.insertRepetition("MFA", rep); 241 } 242 243 244 /** 245 * <p> 246 * Removes a specific repetition of MFA (Master file acknowledgement segment) 247 * </p> 248 * 249 * 250 * @see AbstractGroup#removeRepetition(String, int) 251 */ 252 public MFA removeMFA(int rep) throws HL7Exception { 253 return (MFA)super.removeRepetition("MFA", rep); 254 } 255 256 257 258 259 /** 260 * <p> 261 * Returns 262 * MFI2 (Master file identification segment) - creates it if necessary 263 * </p> 264 * 265 * 266 */ 267 public MFI getMFI2() { 268 return getTyped("MFI2", MFI.class); 269 } 270 271 272 273 274 275 /** 276 * <p> 277 * Returns 278 * the first repetition of 279 * MF (a Group object) - creates it if necessary 280 * </p> 281 * 282 * 283 */ 284 public MFK_M01_MF getMF() { 285 return getTyped("MF", MFK_M01_MF.class); 286 } 287 288 289 /** 290 * <p> 291 * Returns a specific repetition of 292 * MF (a Group object) - creates it if necessary 293 * </p> 294 * 295 * 296 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 297 * @throws HL7Exception if the repetition requested is more than one 298 * greater than the number of existing repetitions. 299 */ 300 public MFK_M01_MF getMF(int rep) { 301 return getTyped("MF", rep, MFK_M01_MF.class); 302 } 303 304 /** 305 * <p> 306 * Returns the number of existing repetitions of MF 307 * </p> 308 * 309 */ 310 public int getMFReps() { 311 return getReps("MF"); 312 } 313 314 /** 315 * <p> 316 * Returns a non-modifiable List containing all current existing repetitions of MF. 317 * <p> 318 * <p> 319 * Note that unlike {@link #getMF()}, this method will not create any reps 320 * if none are already present, so an empty list may be returned. 321 * </p> 322 * 323 */ 324 public java.util.List<MFK_M01_MF> getMFAll() throws HL7Exception { 325 return getAllAsList("MF", MFK_M01_MF.class); 326 } 327 328 /** 329 * <p> 330 * Inserts a specific repetition of MF (a Group object) 331 * </p> 332 * 333 * 334 * @see AbstractGroup#insertRepetition(Structure, int) 335 */ 336 public void insertMF(MFK_M01_MF structure, int rep) throws HL7Exception { 337 super.insertRepetition( "MF", structure, rep); 338 } 339 340 341 /** 342 * <p> 343 * Inserts a specific repetition of MF (a Group object) 344 * </p> 345 * 346 * 347 * @see AbstractGroup#insertRepetition(Structure, int) 348 */ 349 public MFK_M01_MF insertMF(int rep) throws HL7Exception { 350 return (MFK_M01_MF)super.insertRepetition("MF", rep); 351 } 352 353 354 /** 355 * <p> 356 * Removes a specific repetition of MF (a Group object) 357 * </p> 358 * 359 * 360 * @see AbstractGroup#removeRepetition(String, int) 361 */ 362 public MFK_M01_MF removeMF(int rep) throws HL7Exception { 363 return (MFK_M01_MF)super.removeRepetition("MF", rep); 364 } 365 366 367 368} 369