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.v231.group; 35 36 import ca.uhn.hl7v2.model.v231.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 SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE 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: SCH (SCH - schedule activity information segment) <b> </b></li> 49 * <li>2: NTE (NTE - notes and comments segment) <b>optional repeating </b></li> 50 * <li>3: SQR_S25_PIDPV1PV2DG1 (a Group object) <b>optional </b></li> 51 * <li>4: SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) <b> repeating </b></li> 52 * </ul> 53 */ 54 //@SuppressWarnings("unused") 55 public class SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE extends AbstractGroup { 56 57 /** 58 * Creates a new SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE group 59 */ 60 public SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE(Group parent, ModelClassFactory factory) { 61 super(parent, factory); 62 init(factory); 63 } 64 65 private void init(ModelClassFactory factory) { 66 try { 67 this.add(SCH.class, true, false, false); 68 this.add(NTE.class, false, true, false); 69 this.add(SQR_S25_PIDPV1PV2DG1.class, false, false, false); 70 this.add(SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE.class, true, true, false); 71 } catch(HL7Exception e) { 72 log.error("Unexpected error creating SQR_S25_SCHNTEPIDPV1PV2DG1RGSAISNTEAIGNTEAIPNTEAILNTE - this is probably a bug in the source code generator.", e); 73 } 74 } 75 76 /** 77 * Returns "2.3.1" 78 */ 79 public String getVersion() { 80 return "2.3.1"; 81 } 82 83 84 85 /** 86 * Returns 87 * SCH (SCH - schedule activity information segment) - creates it if necessary 88 */ 89 public SCH getSCH() { 90 SCH retVal = getTyped("SCH", SCH.class); 91 return retVal; 92 } 93 94 95 96 97 /** 98 * Returns 99 * the first repetition of 100 * NTE (NTE - notes and comments segment) - creates it if necessary 101 */ 102 public NTE getNTE() { 103 NTE retVal = getTyped("NTE", NTE.class); 104 return retVal; 105 } 106 107 108 /** 109 * Returns a specific repetition of 110 * NTE (NTE - notes and comments segment) - creates it if necessary 111 * 112 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 113 * @throws HL7Exception if the repetition requested is more than one 114 * greater than the number of existing repetitions. 115 */ 116 public NTE getNTE(int rep) { 117 NTE retVal = getTyped("NTE", rep, NTE.class); 118 return retVal; 119 } 120 121 /** 122 * Returns the number of existing repetitions of NTE 123 */ 124 public int getNTEReps() { 125 return getReps("NTE"); 126 } 127 128 /** 129 * <p> 130 * Returns a non-modifiable List containing all current existing repetitions of NTE. 131 * <p> 132 * <p> 133 * Note that unlike {@link #getNTE()}, this method will not create any reps 134 * if none are already present, so an empty list may be returned. 135 * </p> 136 */ 137 public java.util.List<NTE> getNTEAll() throws HL7Exception { 138 return getAllAsList("NTE", NTE.class); 139 } 140 141 /** 142 * Inserts a specific repetition of NTE (NTE - notes and comments segment) 143 * @see AbstractGroup#insertRepetition(Structure, int) 144 */ 145 public void insertNTE(NTE structure, int rep) throws HL7Exception { 146 super.insertRepetition("NTE", structure, rep); 147 } 148 149 150 /** 151 * Inserts a specific repetition of NTE (NTE - notes and comments segment) 152 * @see AbstractGroup#insertRepetition(Structure, int) 153 */ 154 public NTE insertNTE(int rep) throws HL7Exception { 155 return (NTE)super.insertRepetition("NTE", rep); 156 } 157 158 159 /** 160 * Removes a specific repetition of NTE (NTE - notes and comments segment) 161 * @see AbstractGroup#removeRepetition(String, int) 162 */ 163 public NTE removeNTE(int rep) throws HL7Exception { 164 return (NTE)super.removeRepetition("NTE", rep); 165 } 166 167 168 169 /** 170 * Returns 171 * PIDPV1PV2DG1 (a Group object) - creates it if necessary 172 */ 173 public SQR_S25_PIDPV1PV2DG1 getPIDPV1PV2DG1() { 174 SQR_S25_PIDPV1PV2DG1 retVal = getTyped("PIDPV1PV2DG1", SQR_S25_PIDPV1PV2DG1.class); 175 return retVal; 176 } 177 178 179 180 181 /** 182 * Returns 183 * the first repetition of 184 * RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) - creates it if necessary 185 */ 186 public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE getRGSAISNTEAIGNTEAIPNTEAILNTE() { 187 SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE retVal = getTyped("RGSAISNTEAIGNTEAIPNTEAILNTE", SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE.class); 188 return retVal; 189 } 190 191 192 /** 193 * Returns a specific repetition of 194 * RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) - creates it if necessary 195 * 196 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 197 * @throws HL7Exception if the repetition requested is more than one 198 * greater than the number of existing repetitions. 199 */ 200 public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE getRGSAISNTEAIGNTEAIPNTEAILNTE(int rep) { 201 SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE retVal = getTyped("RGSAISNTEAIGNTEAIPNTEAILNTE", rep, SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE.class); 202 return retVal; 203 } 204 205 /** 206 * Returns the number of existing repetitions of RGSAISNTEAIGNTEAIPNTEAILNTE 207 */ 208 public int getRGSAISNTEAIGNTEAIPNTEAILNTEReps() { 209 return getReps("RGSAISNTEAIGNTEAIPNTEAILNTE"); 210 } 211 212 /** 213 * <p> 214 * Returns a non-modifiable List containing all current existing repetitions of RGSAISNTEAIGNTEAIPNTEAILNTE. 215 * <p> 216 * <p> 217 * Note that unlike {@link #getRGSAISNTEAIGNTEAIPNTEAILNTE()}, this method will not create any reps 218 * if none are already present, so an empty list may be returned. 219 * </p> 220 */ 221 public java.util.List<SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE> getRGSAISNTEAIGNTEAIPNTEAILNTEAll() throws HL7Exception { 222 return getAllAsList("RGSAISNTEAIGNTEAIPNTEAILNTE", SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE.class); 223 } 224 225 /** 226 * Inserts a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) 227 * @see AbstractGroup#insertRepetition(Structure, int) 228 */ 229 public void insertRGSAISNTEAIGNTEAIPNTEAILNTE(SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE structure, int rep) throws HL7Exception { 230 super.insertRepetition("RGSAISNTEAIGNTEAIPNTEAILNTE", structure, rep); 231 } 232 233 234 /** 235 * Inserts a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) 236 * @see AbstractGroup#insertRepetition(Structure, int) 237 */ 238 public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE insertRGSAISNTEAIGNTEAIPNTEAILNTE(int rep) throws HL7Exception { 239 return (SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE)super.insertRepetition("RGSAISNTEAIGNTEAIPNTEAILNTE", rep); 240 } 241 242 243 /** 244 * Removes a specific repetition of RGSAISNTEAIGNTEAIPNTEAILNTE (a Group object) 245 * @see AbstractGroup#removeRepetition(String, int) 246 */ 247 public SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE removeRGSAISNTEAIGNTEAIPNTEAILNTE(int rep) throws HL7Exception { 248 return (SQR_S25_RGSAISNTEAIGNTEAIPNTEAILNTE)super.removeRepetition("RGSAISNTEAIGNTEAIPNTEAILNTE", rep); 249 } 250 251 252 253 } 254