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.v281.group; 35 36 import ca.uhn.hl7v2.model.v281.segment.*; 37 38 import ca.uhn.hl7v2.HL7Exception; 39 import ca.uhn.hl7v2.parser.ModelClassFactory; 40 import ca.uhn.hl7v2.model.*; 41 42 /** 43 * <p>Represents a DFT_P11_FINANCIAL_INSURANCE group structure (a Group object). 44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 45 * This Group contains the following elements: 46 * </p> 47 * <ul> 48 * <li>1: IN1 (Insurance) <b> </b></li> 49 * <li>2: IN2 (Insurance Additional Information) <b>optional </b></li> 50 * <li>3: IN3 (Insurance Additional Information, Certification) <b>optional repeating </b></li> 51 * <li>4: PRT (Participation Information) <b>optional repeating </b></li> 52 * <li>5: ROL (Role) <b>optional repeating </b></li> 53 * </ul> 54 */ 55 //@SuppressWarnings("unused") 56 public class DFT_P11_FINANCIAL_INSURANCE extends AbstractGroup { 57 58 /** 59 * Creates a new DFT_P11_FINANCIAL_INSURANCE group 60 */ 61 public DFT_P11_FINANCIAL_INSURANCE(Group parent, ModelClassFactory factory) { 62 super(parent, factory); 63 init(factory); 64 } 65 66 private void init(ModelClassFactory factory) { 67 try { 68 this.add(IN1.class, true, false, false); 69 this.add(IN2.class, false, false, false); 70 this.add(IN3.class, false, true, false); 71 this.add(PRT.class, false, true, false); 72 this.add(ROL.class, false, true, false); 73 } catch(HL7Exception e) { 74 log.error("Unexpected error creating DFT_P11_FINANCIAL_INSURANCE - this is probably a bug in the source code generator.", e); 75 } 76 } 77 78 /** 79 * Returns "2.8.1" 80 */ 81 public String getVersion() { 82 return "2.8.1"; 83 } 84 85 86 87 /** 88 * Returns 89 * IN1 (Insurance) - creates it if necessary 90 */ 91 public IN1 getIN1() { 92 IN1 retVal = getTyped("IN1", IN1.class); 93 return retVal; 94 } 95 96 97 98 99 /** 100 * Returns 101 * IN2 (Insurance Additional Information) - creates it if necessary 102 */ 103 public IN2 getIN2() { 104 IN2 retVal = getTyped("IN2", IN2.class); 105 return retVal; 106 } 107 108 109 110 111 /** 112 * Returns 113 * the first repetition of 114 * IN3 (Insurance Additional Information, Certification) - creates it if necessary 115 */ 116 public IN3 getIN3() { 117 IN3 retVal = getTyped("IN3", IN3.class); 118 return retVal; 119 } 120 121 122 /** 123 * Returns a specific repetition of 124 * IN3 (Insurance Additional Information, Certification) - creates it if necessary 125 * 126 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 127 * @throws HL7Exception if the repetition requested is more than one 128 * greater than the number of existing repetitions. 129 */ 130 public IN3 getIN3(int rep) { 131 IN3 retVal = getTyped("IN3", rep, IN3.class); 132 return retVal; 133 } 134 135 /** 136 * Returns the number of existing repetitions of IN3 137 */ 138 public int getIN3Reps() { 139 return getReps("IN3"); 140 } 141 142 /** 143 * <p> 144 * Returns a non-modifiable List containing all current existing repetitions of IN3. 145 * <p> 146 * <p> 147 * Note that unlike {@link #getIN3()}, this method will not create any reps 148 * if none are already present, so an empty list may be returned. 149 * </p> 150 */ 151 public java.util.List<IN3> getIN3All() throws HL7Exception { 152 return getAllAsList("IN3", IN3.class); 153 } 154 155 /** 156 * Inserts a specific repetition of IN3 (Insurance Additional Information, Certification) 157 * @see AbstractGroup#insertRepetition(Structure, int) 158 */ 159 public void insertIN3(IN3 structure, int rep) throws HL7Exception { 160 super.insertRepetition("IN3", structure, rep); 161 } 162 163 164 /** 165 * Inserts a specific repetition of IN3 (Insurance Additional Information, Certification) 166 * @see AbstractGroup#insertRepetition(Structure, int) 167 */ 168 public IN3 insertIN3(int rep) throws HL7Exception { 169 return (IN3)super.insertRepetition("IN3", rep); 170 } 171 172 173 /** 174 * Removes a specific repetition of IN3 (Insurance Additional Information, Certification) 175 * @see AbstractGroup#removeRepetition(String, int) 176 */ 177 public IN3 removeIN3(int rep) throws HL7Exception { 178 return (IN3)super.removeRepetition("IN3", rep); 179 } 180 181 182 183 /** 184 * Returns 185 * the first repetition of 186 * PRT (Participation Information) - creates it if necessary 187 */ 188 public PRT getPRT() { 189 PRT retVal = getTyped("PRT", PRT.class); 190 return retVal; 191 } 192 193 194 /** 195 * Returns a specific repetition of 196 * PRT (Participation Information) - creates it if necessary 197 * 198 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 199 * @throws HL7Exception if the repetition requested is more than one 200 * greater than the number of existing repetitions. 201 */ 202 public PRT getPRT(int rep) { 203 PRT retVal = getTyped("PRT", rep, PRT.class); 204 return retVal; 205 } 206 207 /** 208 * Returns the number of existing repetitions of PRT 209 */ 210 public int getPRTReps() { 211 return getReps("PRT"); 212 } 213 214 /** 215 * <p> 216 * Returns a non-modifiable List containing all current existing repetitions of PRT. 217 * <p> 218 * <p> 219 * Note that unlike {@link #getPRT()}, this method will not create any reps 220 * if none are already present, so an empty list may be returned. 221 * </p> 222 */ 223 public java.util.List<PRT> getPRTAll() throws HL7Exception { 224 return getAllAsList("PRT", PRT.class); 225 } 226 227 /** 228 * Inserts a specific repetition of PRT (Participation Information) 229 * @see AbstractGroup#insertRepetition(Structure, int) 230 */ 231 public void insertPRT(PRT structure, int rep) throws HL7Exception { 232 super.insertRepetition("PRT", structure, rep); 233 } 234 235 236 /** 237 * Inserts a specific repetition of PRT (Participation Information) 238 * @see AbstractGroup#insertRepetition(Structure, int) 239 */ 240 public PRT insertPRT(int rep) throws HL7Exception { 241 return (PRT)super.insertRepetition("PRT", rep); 242 } 243 244 245 /** 246 * Removes a specific repetition of PRT (Participation Information) 247 * @see AbstractGroup#removeRepetition(String, int) 248 */ 249 public PRT removePRT(int rep) throws HL7Exception { 250 return (PRT)super.removeRepetition("PRT", rep); 251 } 252 253 254 255 /** 256 * Returns 257 * the first repetition of 258 * ROL (Role) - creates it if necessary 259 */ 260 public ROL getROL() { 261 ROL retVal = getTyped("ROL", ROL.class); 262 return retVal; 263 } 264 265 266 /** 267 * Returns a specific repetition of 268 * ROL (Role) - creates it if necessary 269 * 270 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 271 * @throws HL7Exception if the repetition requested is more than one 272 * greater than the number of existing repetitions. 273 */ 274 public ROL getROL(int rep) { 275 ROL retVal = getTyped("ROL", rep, ROL.class); 276 return retVal; 277 } 278 279 /** 280 * Returns the number of existing repetitions of ROL 281 */ 282 public int getROLReps() { 283 return getReps("ROL"); 284 } 285 286 /** 287 * <p> 288 * Returns a non-modifiable List containing all current existing repetitions of ROL. 289 * <p> 290 * <p> 291 * Note that unlike {@link #getROL()}, this method will not create any reps 292 * if none are already present, so an empty list may be returned. 293 * </p> 294 */ 295 public java.util.List<ROL> getROLAll() throws HL7Exception { 296 return getAllAsList("ROL", ROL.class); 297 } 298 299 /** 300 * Inserts a specific repetition of ROL (Role) 301 * @see AbstractGroup#insertRepetition(Structure, int) 302 */ 303 public void insertROL(ROL structure, int rep) throws HL7Exception { 304 super.insertRepetition("ROL", structure, rep); 305 } 306 307 308 /** 309 * Inserts a specific repetition of ROL (Role) 310 * @see AbstractGroup#insertRepetition(Structure, int) 311 */ 312 public ROL insertROL(int rep) throws HL7Exception { 313 return (ROL)super.insertRepetition("ROL", rep); 314 } 315 316 317 /** 318 * Removes a specific repetition of ROL (Role) 319 * @see AbstractGroup#removeRepetition(String, int) 320 */ 321 public ROL removeROL(int rep) throws HL7Exception { 322 return (ROL)super.removeRepetition("ROL", rep); 323 } 324 325 326 327 } 328