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.v22.message; 35 36 import ca.uhn.hl7v2.model.v22.group.*; 37 import ca.uhn.hl7v2.model.v22.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 MFD_M02 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: MFI (MASTER FILE IDENTIFICATION) <b> </b> </li> 51 * <li>3: MFA (MASTER FILE ACKNOWLEDGEMENT) <b>optional repeating</b> </li> 52 * </ul> 53 */ 54 //@SuppressWarnings("unused") 55 public class MFD_M02 extends AbstractMessage { 56 57 /** 58 * Creates a new MFD_M02 message with DefaultModelClassFactory. 59 */ 60 public MFD_M02() { 61 this(new DefaultModelClassFactory()); 62 } 63 64 /** 65 * Creates a new MFD_M02 message with custom ModelClassFactory. 66 */ 67 public MFD_M02(ModelClassFactory factory) { 68 super(factory); 69 init(factory); 70 } 71 72 private void init(ModelClassFactory factory) { 73 try { 74 this.add(MSH.class, true, false); 75 this.add(MFI.class, true, false); 76 this.add(MFA.class, false, true); 77 } catch(HL7Exception e) { 78 log.error("Unexpected error creating MFD_M02 - this is probably a bug in the source code generator.", e); 79 } 80 } 81 82 83 /** 84 * Returns "2.2" 85 */ 86 public String getVersion() { 87 return "2.2"; 88 } 89 90 91 92 93 /** 94 * <p> 95 * Returns 96 * MSH (MESSAGE HEADER) - creates it if necessary 97 * </p> 98 * 99 * 100 */ 101 public MSH getMSH() { 102 return getTyped("MSH", MSH.class); 103 } 104 105 106 107 108 109 /** 110 * <p> 111 * Returns 112 * MFI (MASTER FILE IDENTIFICATION) - creates it if necessary 113 * </p> 114 * 115 * 116 */ 117 public MFI getMFI() { 118 return getTyped("MFI", MFI.class); 119 } 120 121 122 123 124 125 /** 126 * <p> 127 * Returns 128 * the first repetition of 129 * MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary 130 * </p> 131 * 132 * 133 */ 134 public MFA getMFA() { 135 return getTyped("MFA", MFA.class); 136 } 137 138 139 /** 140 * <p> 141 * Returns a specific repetition of 142 * MFA (MASTER FILE ACKNOWLEDGEMENT) - creates it if necessary 143 * </p> 144 * 145 * 146 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 147 * @throws HL7Exception if the repetition requested is more than one 148 * greater than the number of existing repetitions. 149 */ 150 public MFA getMFA(int rep) { 151 return getTyped("MFA", rep, MFA.class); 152 } 153 154 /** 155 * <p> 156 * Returns the number of existing repetitions of MFA 157 * </p> 158 * 159 */ 160 public int getMFAReps() { 161 return getReps("MFA"); 162 } 163 164 /** 165 * <p> 166 * Returns a non-modifiable List containing all current existing repetitions of MFA. 167 * <p> 168 * <p> 169 * Note that unlike {@link #getMFA()}, this method will not create any reps 170 * if none are already present, so an empty list may be returned. 171 * </p> 172 * 173 */ 174 public java.util.List<MFA> getMFAAll() throws HL7Exception { 175 return getAllAsList("MFA", MFA.class); 176 } 177 178 /** 179 * <p> 180 * Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) 181 * </p> 182 * 183 * 184 * @see AbstractGroup#insertRepetition(Structure, int) 185 */ 186 public void insertMFA(MFA structure, int rep) throws HL7Exception { 187 super.insertRepetition( "MFA", structure, rep); 188 } 189 190 191 /** 192 * <p> 193 * Inserts a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) 194 * </p> 195 * 196 * 197 * @see AbstractGroup#insertRepetition(Structure, int) 198 */ 199 public MFA insertMFA(int rep) throws HL7Exception { 200 return (MFA)super.insertRepetition("MFA", rep); 201 } 202 203 204 /** 205 * <p> 206 * Removes a specific repetition of MFA (MASTER FILE ACKNOWLEDGEMENT) 207 * </p> 208 * 209 * 210 * @see AbstractGroup#removeRepetition(String, int) 211 */ 212 public MFA removeMFA(int rep) throws HL7Exception { 213 return (MFA)super.removeRepetition("MFA", rep); 214 } 215 216 217 218 } 219