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