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