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.v28.group; 35 36 import ca.uhn.hl7v2.model.v28.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 MFN_M09_MF_TEST_CATEGORICAL 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: MFE (Master File Entry) <b> </b></li> 49 * <li>2: OM1 (General Segment) <b> </b></li> 50 * <li>3: PRT (Participation Information) <b>optional repeating </b></li> 51 * <li>4: MFN_M09_MF_TEST_CAT_DETAIL (a Group object) <b>optional </b></li> 52 * </ul> 53 */ 54 //@SuppressWarnings("unused") 55 public class MFN_M09_MF_TEST_CATEGORICAL extends AbstractGroup { 56 57 /** 58 * Creates a new MFN_M09_MF_TEST_CATEGORICAL group 59 */ 60 public MFN_M09_MF_TEST_CATEGORICAL(Group parent, ModelClassFactory factory) { 61 super(parent, factory); 62 init(factory); 63 } 64 65 private void init(ModelClassFactory factory) { 66 try { 67 this.add(MFE.class, true, false, false); 68 this.add(OM1.class, true, false, false); 69 this.add(PRT.class, false, true, false); 70 this.add(MFN_M09_MF_TEST_CAT_DETAIL.class, false, false, false); 71 } catch(HL7Exception e) { 72 log.error("Unexpected error creating MFN_M09_MF_TEST_CATEGORICAL - this is probably a bug in the source code generator.", e); 73 } 74 } 75 76 /** 77 * Returns "2.8" 78 */ 79 public String getVersion() { 80 return "2.8"; 81 } 82 83 84 85 /** 86 * Returns 87 * MFE (Master File Entry) - creates it if necessary 88 */ 89 public MFE getMFE() { 90 MFE retVal = getTyped("MFE", MFE.class); 91 return retVal; 92 } 93 94 95 96 97 /** 98 * Returns 99 * OM1 (General Segment) - creates it if necessary 100 */ 101 public OM1 getOM1() { 102 OM1 retVal = getTyped("OM1", OM1.class); 103 return retVal; 104 } 105 106 107 108 109 /** 110 * Returns 111 * the first repetition of 112 * PRT (Participation Information) - creates it if necessary 113 */ 114 public PRT getPRT() { 115 PRT retVal = getTyped("PRT", PRT.class); 116 return retVal; 117 } 118 119 120 /** 121 * Returns a specific repetition of 122 * PRT (Participation Information) - creates it if necessary 123 * 124 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 125 * @throws HL7Exception if the repetition requested is more than one 126 * greater than the number of existing repetitions. 127 */ 128 public PRT getPRT(int rep) { 129 PRT retVal = getTyped("PRT", rep, PRT.class); 130 return retVal; 131 } 132 133 /** 134 * Returns the number of existing repetitions of PRT 135 */ 136 public int getPRTReps() { 137 return getReps("PRT"); 138 } 139 140 /** 141 * <p> 142 * Returns a non-modifiable List containing all current existing repetitions of PRT. 143 * <p> 144 * <p> 145 * Note that unlike {@link #getPRT()}, this method will not create any reps 146 * if none are already present, so an empty list may be returned. 147 * </p> 148 */ 149 public java.util.List<PRT> getPRTAll() throws HL7Exception { 150 return getAllAsList("PRT", PRT.class); 151 } 152 153 /** 154 * Inserts a specific repetition of PRT (Participation Information) 155 * @see AbstractGroup#insertRepetition(Structure, int) 156 */ 157 public void insertPRT(PRT structure, int rep) throws HL7Exception { 158 super.insertRepetition("PRT", structure, rep); 159 } 160 161 162 /** 163 * Inserts a specific repetition of PRT (Participation Information) 164 * @see AbstractGroup#insertRepetition(Structure, int) 165 */ 166 public PRT insertPRT(int rep) throws HL7Exception { 167 return (PRT)super.insertRepetition("PRT", rep); 168 } 169 170 171 /** 172 * Removes a specific repetition of PRT (Participation Information) 173 * @see AbstractGroup#removeRepetition(String, int) 174 */ 175 public PRT removePRT(int rep) throws HL7Exception { 176 return (PRT)super.removeRepetition("PRT", rep); 177 } 178 179 180 181 /** 182 * Returns 183 * MF_TEST_CAT_DETAIL (a Group object) - creates it if necessary 184 */ 185 public MFN_M09_MF_TEST_CAT_DETAIL getMF_TEST_CAT_DETAIL() { 186 MFN_M09_MF_TEST_CAT_DETAIL retVal = getTyped("MF_TEST_CAT_DETAIL", MFN_M09_MF_TEST_CAT_DETAIL.class); 187 return retVal; 188 } 189 190 191 192 193 } 194