001/* 002 * This class is an auto-generated source file for a HAPI 003 * HL7 v2.x standard structure class. 004 * 005 * For more information, visit: http://hl7api.sourceforge.net/ 006 * 007 * The contents of this file are subject to the Mozilla Public License Version 1.1 008 * (the "License"); you may not use this file except in compliance with the License. 009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 010 * Software distributed under the License is distributed on an "AS IS" basis, 011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 012 * specific language governing rights and limitations under the License. 013 * 014 * The Original Code is "[file_name]". Description: 015 * "[one_line_description]" 016 * 017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 018 * 2012. All Rights Reserved. 019 * 020 * Contributor(s): ______________________________________. 021 * 022 * Alternatively, the contents of this file may be used under the terms of the 023 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 024 * applicable instead of those above. If you wish to allow use of your version of this 025 * file only under the terms of the GPL and not to allow others to use your version 026 * of this file under the MPL, indicate your decision by deleting the provisions above 027 * and replace them with the notice and other provisions required by the GPL License. 028 * If you do not delete the provisions above, a recipient may use your version of 029 * this file under either the MPL or the GPL. 030 * 031 */ 032 033 034package ca.uhn.hl7v2.model.v26.group; 035 036import ca.uhn.hl7v2.model.v26.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a OUL_R24_SPECIMEN group structure (a Group object). 044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 045 * This Group contains the following elements: 046 * </p> 047 * <ul> 048 * <li>1: SPM (Specimen) <b> </b></li> 049 * <li>2: OBX (Observation/Result) <b>optional repeating </b></li> 050 * <li>3: OUL_R24_CONTAINER (a Group object) <b>optional repeating </b></li> 051 * </ul> 052 */ 053//@SuppressWarnings("unused") 054public class OUL_R24_SPECIMEN extends AbstractGroup { 055 056 /** 057 * Creates a new OUL_R24_SPECIMEN group 058 */ 059 public OUL_R24_SPECIMEN(Group parent, ModelClassFactory factory) { 060 super(parent, factory); 061 init(factory); 062 } 063 064 private void init(ModelClassFactory factory) { 065 try { 066 this.add(SPM.class, true, false, false); 067 this.add(OBX.class, false, true, false); 068 this.add(OUL_R24_CONTAINER.class, false, true, false); 069 } catch(HL7Exception e) { 070 log.error("Unexpected error creating OUL_R24_SPECIMEN - this is probably a bug in the source code generator.", e); 071 } 072 } 073 074 /** 075 * Returns "2.6" 076 */ 077 public String getVersion() { 078 return "2.6"; 079 } 080 081 082 083 /** 084 * Returns 085 * SPM (Specimen) - creates it if necessary 086 */ 087 public SPM getSPM() { 088 SPM retVal = getTyped("SPM", SPM.class); 089 return retVal; 090 } 091 092 093 094 095 /** 096 * Returns 097 * the first repetition of 098 * OBX (Observation/Result) - creates it if necessary 099 */ 100 public OBX getOBX() { 101 OBX retVal = getTyped("OBX", OBX.class); 102 return retVal; 103 } 104 105 106 /** 107 * Returns a specific repetition of 108 * OBX (Observation/Result) - creates it if necessary 109 * 110 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 111 * @throws HL7Exception if the repetition requested is more than one 112 * greater than the number of existing repetitions. 113 */ 114 public OBX getOBX(int rep) { 115 OBX retVal = getTyped("OBX", rep, OBX.class); 116 return retVal; 117 } 118 119 /** 120 * Returns the number of existing repetitions of OBX 121 */ 122 public int getOBXReps() { 123 return getReps("OBX"); 124 } 125 126 /** 127 * <p> 128 * Returns a non-modifiable List containing all current existing repetitions of OBX. 129 * <p> 130 * <p> 131 * Note that unlike {@link #getOBX()}, this method will not create any reps 132 * if none are already present, so an empty list may be returned. 133 * </p> 134 */ 135 public java.util.List<OBX> getOBXAll() throws HL7Exception { 136 return getAllAsList("OBX", OBX.class); 137 } 138 139 /** 140 * Inserts a specific repetition of OBX (Observation/Result) 141 * @see AbstractGroup#insertRepetition(Structure, int) 142 */ 143 public void insertOBX(OBX structure, int rep) throws HL7Exception { 144 super.insertRepetition("OBX", structure, rep); 145 } 146 147 148 /** 149 * Inserts a specific repetition of OBX (Observation/Result) 150 * @see AbstractGroup#insertRepetition(Structure, int) 151 */ 152 public OBX insertOBX(int rep) throws HL7Exception { 153 return (OBX)super.insertRepetition("OBX", rep); 154 } 155 156 157 /** 158 * Removes a specific repetition of OBX (Observation/Result) 159 * @see AbstractGroup#removeRepetition(String, int) 160 */ 161 public OBX removeOBX(int rep) throws HL7Exception { 162 return (OBX)super.removeRepetition("OBX", rep); 163 } 164 165 166 167 /** 168 * Returns 169 * the first repetition of 170 * CONTAINER (a Group object) - creates it if necessary 171 */ 172 public OUL_R24_CONTAINER getCONTAINER() { 173 OUL_R24_CONTAINER retVal = getTyped("CONTAINER", OUL_R24_CONTAINER.class); 174 return retVal; 175 } 176 177 178 /** 179 * Returns a specific repetition of 180 * CONTAINER (a Group object) - creates it if necessary 181 * 182 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 183 * @throws HL7Exception if the repetition requested is more than one 184 * greater than the number of existing repetitions. 185 */ 186 public OUL_R24_CONTAINER getCONTAINER(int rep) { 187 OUL_R24_CONTAINER retVal = getTyped("CONTAINER", rep, OUL_R24_CONTAINER.class); 188 return retVal; 189 } 190 191 /** 192 * Returns the number of existing repetitions of CONTAINER 193 */ 194 public int getCONTAINERReps() { 195 return getReps("CONTAINER"); 196 } 197 198 /** 199 * <p> 200 * Returns a non-modifiable List containing all current existing repetitions of CONTAINER. 201 * <p> 202 * <p> 203 * Note that unlike {@link #getCONTAINER()}, this method will not create any reps 204 * if none are already present, so an empty list may be returned. 205 * </p> 206 */ 207 public java.util.List<OUL_R24_CONTAINER> getCONTAINERAll() throws HL7Exception { 208 return getAllAsList("CONTAINER", OUL_R24_CONTAINER.class); 209 } 210 211 /** 212 * Inserts a specific repetition of CONTAINER (a Group object) 213 * @see AbstractGroup#insertRepetition(Structure, int) 214 */ 215 public void insertCONTAINER(OUL_R24_CONTAINER structure, int rep) throws HL7Exception { 216 super.insertRepetition("CONTAINER", structure, rep); 217 } 218 219 220 /** 221 * Inserts a specific repetition of CONTAINER (a Group object) 222 * @see AbstractGroup#insertRepetition(Structure, int) 223 */ 224 public OUL_R24_CONTAINER insertCONTAINER(int rep) throws HL7Exception { 225 return (OUL_R24_CONTAINER)super.insertRepetition("CONTAINER", rep); 226 } 227 228 229 /** 230 * Removes a specific repetition of CONTAINER (a Group object) 231 * @see AbstractGroup#removeRepetition(String, int) 232 */ 233 public OUL_R24_CONTAINER removeCONTAINER(int rep) throws HL7Exception { 234 return (OUL_R24_CONTAINER)super.removeRepetition("CONTAINER", rep); 235 } 236 237 238 239} 240