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.v251.message; 035 036import ca.uhn.hl7v2.model.v251.group.*; 037import ca.uhn.hl7v2.model.v251.segment.*; 038 039import ca.uhn.hl7v2.HL7Exception; 040import ca.uhn.hl7v2.parser.ModelClassFactory; 041import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 042import ca.uhn.hl7v2.model.*; 043 044 045/** 046 * <p>Represents a SSU_U03 message structure (see chapter 13.3.3). This structure contains the 047 * following elements: </p> 048 * <ul> 049 * <li>1: MSH (Message Header) <b> </b> </li> 050 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li> 051 * <li>3: EQU (Equipment Detail) <b> </b> </li> 052 * <li>4: SSU_U03_SPECIMEN_CONTAINER (a Group object) <b> repeating</b> </li> 053 * <li>5: ROL (Role) <b>optional </b> </li> 054 * </ul> 055 */ 056//@SuppressWarnings("unused") 057public class SSU_U03 extends AbstractMessage { 058 059 /** 060 * Creates a new SSU_U03 message with DefaultModelClassFactory. 061 */ 062 public SSU_U03() { 063 this(new DefaultModelClassFactory()); 064 } 065 066 /** 067 * Creates a new SSU_U03 message with custom ModelClassFactory. 068 */ 069 public SSU_U03(ModelClassFactory factory) { 070 super(factory); 071 init(factory); 072 } 073 074 private void init(ModelClassFactory factory) { 075 try { 076 this.add(MSH.class, true, false); 077 this.add(SFT.class, false, true); 078 this.add(EQU.class, true, false); 079 this.add(SSU_U03_SPECIMEN_CONTAINER.class, true, true); 080 this.add(ROL.class, false, false); 081 } catch(HL7Exception e) { 082 log.error("Unexpected error creating SSU_U03 - this is probably a bug in the source code generator.", e); 083 } 084 } 085 086 087 /** 088 * Returns "2.5.1" 089 */ 090 public String getVersion() { 091 return "2.5.1"; 092 } 093 094 095 096 097 /** 098 * <p> 099 * Returns 100 * MSH (Message Header) - creates it if necessary 101 * </p> 102 * 103 * 104 */ 105 public MSH getMSH() { 106 return getTyped("MSH", MSH.class); 107 } 108 109 110 111 112 113 /** 114 * <p> 115 * Returns 116 * the first repetition of 117 * SFT (Software Segment) - creates it if necessary 118 * </p> 119 * 120 * 121 */ 122 public SFT getSFT() { 123 return getTyped("SFT", SFT.class); 124 } 125 126 127 /** 128 * <p> 129 * Returns a specific repetition of 130 * SFT (Software Segment) - creates it if necessary 131 * </p> 132 * 133 * 134 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 135 * @throws HL7Exception if the repetition requested is more than one 136 * greater than the number of existing repetitions. 137 */ 138 public SFT getSFT(int rep) { 139 return getTyped("SFT", rep, SFT.class); 140 } 141 142 /** 143 * <p> 144 * Returns the number of existing repetitions of SFT 145 * </p> 146 * 147 */ 148 public int getSFTReps() { 149 return getReps("SFT"); 150 } 151 152 /** 153 * <p> 154 * Returns a non-modifiable List containing all current existing repetitions of SFT. 155 * <p> 156 * <p> 157 * Note that unlike {@link #getSFT()}, this method will not create any reps 158 * if none are already present, so an empty list may be returned. 159 * </p> 160 * 161 */ 162 public java.util.List<SFT> getSFTAll() throws HL7Exception { 163 return getAllAsList("SFT", SFT.class); 164 } 165 166 /** 167 * <p> 168 * Inserts a specific repetition of SFT (Software Segment) 169 * </p> 170 * 171 * 172 * @see AbstractGroup#insertRepetition(Structure, int) 173 */ 174 public void insertSFT(SFT structure, int rep) throws HL7Exception { 175 super.insertRepetition( "SFT", structure, rep); 176 } 177 178 179 /** 180 * <p> 181 * Inserts a specific repetition of SFT (Software Segment) 182 * </p> 183 * 184 * 185 * @see AbstractGroup#insertRepetition(Structure, int) 186 */ 187 public SFT insertSFT(int rep) throws HL7Exception { 188 return (SFT)super.insertRepetition("SFT", rep); 189 } 190 191 192 /** 193 * <p> 194 * Removes a specific repetition of SFT (Software Segment) 195 * </p> 196 * 197 * 198 * @see AbstractGroup#removeRepetition(String, int) 199 */ 200 public SFT removeSFT(int rep) throws HL7Exception { 201 return (SFT)super.removeRepetition("SFT", rep); 202 } 203 204 205 206 207 /** 208 * <p> 209 * Returns 210 * EQU (Equipment Detail) - creates it if necessary 211 * </p> 212 * 213 * 214 */ 215 public EQU getEQU() { 216 return getTyped("EQU", EQU.class); 217 } 218 219 220 221 222 223 /** 224 * <p> 225 * Returns 226 * the first repetition of 227 * SPECIMEN_CONTAINER (a Group object) - creates it if necessary 228 * </p> 229 * 230 * 231 */ 232 public SSU_U03_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER() { 233 return getTyped("SPECIMEN_CONTAINER", SSU_U03_SPECIMEN_CONTAINER.class); 234 } 235 236 237 /** 238 * <p> 239 * Returns a specific repetition of 240 * SPECIMEN_CONTAINER (a Group object) - creates it if necessary 241 * </p> 242 * 243 * 244 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 245 * @throws HL7Exception if the repetition requested is more than one 246 * greater than the number of existing repetitions. 247 */ 248 public SSU_U03_SPECIMEN_CONTAINER getSPECIMEN_CONTAINER(int rep) { 249 return getTyped("SPECIMEN_CONTAINER", rep, SSU_U03_SPECIMEN_CONTAINER.class); 250 } 251 252 /** 253 * <p> 254 * Returns the number of existing repetitions of SPECIMEN_CONTAINER 255 * </p> 256 * 257 */ 258 public int getSPECIMEN_CONTAINERReps() { 259 return getReps("SPECIMEN_CONTAINER"); 260 } 261 262 /** 263 * <p> 264 * Returns a non-modifiable List containing all current existing repetitions of SPECIMEN_CONTAINER. 265 * <p> 266 * <p> 267 * Note that unlike {@link #getSPECIMEN_CONTAINER()}, this method will not create any reps 268 * if none are already present, so an empty list may be returned. 269 * </p> 270 * 271 */ 272 public java.util.List<SSU_U03_SPECIMEN_CONTAINER> getSPECIMEN_CONTAINERAll() throws HL7Exception { 273 return getAllAsList("SPECIMEN_CONTAINER", SSU_U03_SPECIMEN_CONTAINER.class); 274 } 275 276 /** 277 * <p> 278 * Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object) 279 * </p> 280 * 281 * 282 * @see AbstractGroup#insertRepetition(Structure, int) 283 */ 284 public void insertSPECIMEN_CONTAINER(SSU_U03_SPECIMEN_CONTAINER structure, int rep) throws HL7Exception { 285 super.insertRepetition( "SPECIMEN_CONTAINER", structure, rep); 286 } 287 288 289 /** 290 * <p> 291 * Inserts a specific repetition of SPECIMEN_CONTAINER (a Group object) 292 * </p> 293 * 294 * 295 * @see AbstractGroup#insertRepetition(Structure, int) 296 */ 297 public SSU_U03_SPECIMEN_CONTAINER insertSPECIMEN_CONTAINER(int rep) throws HL7Exception { 298 return (SSU_U03_SPECIMEN_CONTAINER)super.insertRepetition("SPECIMEN_CONTAINER", rep); 299 } 300 301 302 /** 303 * <p> 304 * Removes a specific repetition of SPECIMEN_CONTAINER (a Group object) 305 * </p> 306 * 307 * 308 * @see AbstractGroup#removeRepetition(String, int) 309 */ 310 public SSU_U03_SPECIMEN_CONTAINER removeSPECIMEN_CONTAINER(int rep) throws HL7Exception { 311 return (SSU_U03_SPECIMEN_CONTAINER)super.removeRepetition("SPECIMEN_CONTAINER", rep); 312 } 313 314 315 316 317 /** 318 * <p> 319 * Returns 320 * ROL (Role) - creates it if necessary 321 * </p> 322 * 323 * 324 */ 325 public ROL getROL() { 326 return getTyped("ROL", ROL.class); 327 } 328 329 330 331 332} 333