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.v251.segment; 35 36 // import ca.uhn.hl7v2.model.v251.group.*; 37 import ca.uhn.hl7v2.model.v251.datatype.*; 38 import ca.uhn.hl7v2.HL7Exception; 39 import ca.uhn.hl7v2.parser.ModelClassFactory; 40 import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 41 import ca.uhn.hl7v2.model.AbstractMessage; 42 import ca.uhn.hl7v2.model.Group; 43 import ca.uhn.hl7v2.model.Type; 44 import ca.uhn.hl7v2.model.AbstractSegment; 45 import ca.uhn.hl7v2.model.Varies; 46 47 48 /** 49 *<p>Represents an HL7 CSS message segment (Clinical Study Data Schedule Segment). 50 * This segment has the following fields:</p> 51 * <ul> 52 * <li>CSS-1: Study Scheduled Time Point (CE) <b> </b> 53 * <li>CSS-2: Study Scheduled Patient Time Point (TS) <b>optional </b> 54 * <li>CSS-3: Study Quality Control Codes (CE) <b>optional repeating</b> 55 * </ul> 56 */ 57 @SuppressWarnings("unused") 58 public class CSS extends AbstractSegment { 59 60 /** 61 * Creates a new CSS segment 62 */ 63 public CSS(Group parent, ModelClassFactory factory) { 64 super(parent, factory); 65 init(factory); 66 } 67 68 private void init(ModelClassFactory factory) { 69 try { 70 this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "Study Scheduled Time Point"); 71 this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Study Scheduled Patient Time Point"); 72 this.add(CE.class, false, 3, 250, new Object[]{ getMessage() }, "Study Quality Control Codes"); 73 } catch(HL7Exception e) { 74 log.error("Unexpected error creating CSS - this is probably a bug in the source code generator.", e); 75 } 76 } 77 78 79 80 /** 81 * Returns 82 * CSS-1: "Study Scheduled Time Point" - creates it if necessary 83 */ 84 public CE getStudyScheduledTimePoint() { 85 CE retVal = this.getTypedField(1, 0); 86 return retVal; 87 } 88 89 /** 90 * Returns 91 * CSS-1: "Study Scheduled Time Point" - creates it if necessary 92 */ 93 public CE getCss1_StudyScheduledTimePoint() { 94 CE retVal = this.getTypedField(1, 0); 95 return retVal; 96 } 97 98 99 100 /** 101 * Returns 102 * CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary 103 */ 104 public TS getStudyScheduledPatientTimePoint() { 105 TS retVal = this.getTypedField(2, 0); 106 return retVal; 107 } 108 109 /** 110 * Returns 111 * CSS-2: "Study Scheduled Patient Time Point" - creates it if necessary 112 */ 113 public TS getCss2_StudyScheduledPatientTimePoint() { 114 TS retVal = this.getTypedField(2, 0); 115 return retVal; 116 } 117 118 119 /** 120 * Returns all repetitions of Study Quality Control Codes (CSS-3). 121 */ 122 public CE[] getStudyQualityControlCodes() { 123 CE[] retVal = this.getTypedField(3, new CE[0]); 124 return retVal; 125 } 126 127 128 /** 129 * Returns all repetitions of Study Quality Control Codes (CSS-3). 130 */ 131 public CE[] getCss3_StudyQualityControlCodes() { 132 CE[] retVal = this.getTypedField(3, new CE[0]); 133 return retVal; 134 } 135 136 137 /** 138 * Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3). 139 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 140 * it will return zero. 141 */ 142 public int getStudyQualityControlCodesReps() { 143 return this.getReps(3); 144 } 145 146 147 /** 148 * Returns a specific repetition of 149 * CSS-3: "Study Quality Control Codes" - creates it if necessary 150 * 151 * @param rep The repetition index (0-indexed) 152 */ 153 public CE getStudyQualityControlCodes(int rep) { 154 CE retVal = this.getTypedField(3, rep); 155 return retVal; 156 } 157 158 /** 159 * Returns a specific repetition of 160 * CSS-3: "Study Quality Control Codes" - creates it if necessary 161 * 162 * @param rep The repetition index (0-indexed) 163 */ 164 public CE getCss3_StudyQualityControlCodes(int rep) { 165 CE retVal = this.getTypedField(3, rep); 166 return retVal; 167 } 168 169 /** 170 * Returns a count of the current number of repetitions of Study Quality Control Codes (CSS-3). 171 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 172 * it will return zero. 173 */ 174 public int getCss3_StudyQualityControlCodesReps() { 175 return this.getReps(3); 176 } 177 178 179 /** 180 * Inserts a repetition of 181 * CSS-3: "Study Quality Control Codes" at a specific index 182 * 183 * @param rep The repetition index (0-indexed) 184 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 185 */ 186 public CE insertStudyQualityControlCodes(int rep) throws HL7Exception { 187 return (CE) super.insertRepetition(3, rep); 188 } 189 190 191 /** 192 * Inserts a repetition of 193 * CSS-3: "Study Quality Control Codes" at a specific index 194 * 195 * @param rep The repetition index (0-indexed) 196 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 197 */ 198 public CE insertCss3_StudyQualityControlCodes(int rep) throws HL7Exception { 199 return (CE) super.insertRepetition(3, rep); 200 } 201 202 203 /** 204 * Removes a repetition of 205 * CSS-3: "Study Quality Control Codes" at a specific index 206 * 207 * @param rep The repetition index (0-indexed) 208 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 209 */ 210 public CE removeStudyQualityControlCodes(int rep) throws HL7Exception { 211 return (CE) super.removeRepetition(3, rep); 212 } 213 214 215 /** 216 * Removes a repetition of 217 * CSS-3: "Study Quality Control Codes" at a specific index 218 * 219 * @param rep The repetition index (0-indexed) 220 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 221 */ 222 public CE removeCss3_StudyQualityControlCodes(int rep) throws HL7Exception { 223 return (CE) super.removeRepetition(3, rep); 224 } 225 226 227 228 229 230 231 /** {@inheritDoc} */ 232 protected Type createNewTypeWithoutReflection(int field) { 233 switch (field) { 234 case 0: return new CE(getMessage()); 235 case 1: return new TS(getMessage()); 236 case 2: return new CE(getMessage()); 237 default: return null; 238 } 239 } 240 241 242 } 243