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.v24.group; 35 36 import ca.uhn.hl7v2.model.v24.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 CSU_C09_STUDY_PHASE 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: CSP (Clinical Study Phase) <b>optional repeating </b></li> 49 * <li>2: CSU_C09_STUDY_SCHEDULE (a Group object) <b> repeating </b></li> 50 * </ul> 51 */ 52 //@SuppressWarnings("unused") 53 public class CSU_C09_STUDY_PHASE extends AbstractGroup { 54 55 /** 56 * Creates a new CSU_C09_STUDY_PHASE group 57 */ 58 public CSU_C09_STUDY_PHASE(Group parent, ModelClassFactory factory) { 59 super(parent, factory); 60 init(factory); 61 } 62 63 private void init(ModelClassFactory factory) { 64 try { 65 this.add(CSP.class, false, true, false); 66 this.add(CSU_C09_STUDY_SCHEDULE.class, true, true, false); 67 } catch(HL7Exception e) { 68 log.error("Unexpected error creating CSU_C09_STUDY_PHASE - this is probably a bug in the source code generator.", e); 69 } 70 } 71 72 /** 73 * Returns "2.4" 74 */ 75 public String getVersion() { 76 return "2.4"; 77 } 78 79 80 81 /** 82 * Returns 83 * the first repetition of 84 * CSP (Clinical Study Phase) - creates it if necessary 85 */ 86 public CSP getCSP() { 87 CSP retVal = getTyped("CSP", CSP.class); 88 return retVal; 89 } 90 91 92 /** 93 * Returns a specific repetition of 94 * CSP (Clinical Study Phase) - creates it if necessary 95 * 96 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 97 * @throws HL7Exception if the repetition requested is more than one 98 * greater than the number of existing repetitions. 99 */ 100 public CSP getCSP(int rep) { 101 CSP retVal = getTyped("CSP", rep, CSP.class); 102 return retVal; 103 } 104 105 /** 106 * Returns the number of existing repetitions of CSP 107 */ 108 public int getCSPReps() { 109 return getReps("CSP"); 110 } 111 112 /** 113 * <p> 114 * Returns a non-modifiable List containing all current existing repetitions of CSP. 115 * <p> 116 * <p> 117 * Note that unlike {@link #getCSP()}, this method will not create any reps 118 * if none are already present, so an empty list may be returned. 119 * </p> 120 */ 121 public java.util.List<CSP> getCSPAll() throws HL7Exception { 122 return getAllAsList("CSP", CSP.class); 123 } 124 125 /** 126 * Inserts a specific repetition of CSP (Clinical Study Phase) 127 * @see AbstractGroup#insertRepetition(Structure, int) 128 */ 129 public void insertCSP(CSP structure, int rep) throws HL7Exception { 130 super.insertRepetition("CSP", structure, rep); 131 } 132 133 134 /** 135 * Inserts a specific repetition of CSP (Clinical Study Phase) 136 * @see AbstractGroup#insertRepetition(Structure, int) 137 */ 138 public CSP insertCSP(int rep) throws HL7Exception { 139 return (CSP)super.insertRepetition("CSP", rep); 140 } 141 142 143 /** 144 * Removes a specific repetition of CSP (Clinical Study Phase) 145 * @see AbstractGroup#removeRepetition(String, int) 146 */ 147 public CSP removeCSP(int rep) throws HL7Exception { 148 return (CSP)super.removeRepetition("CSP", rep); 149 } 150 151 152 153 /** 154 * Returns 155 * the first repetition of 156 * STUDY_SCHEDULE (a Group object) - creates it if necessary 157 */ 158 public CSU_C09_STUDY_SCHEDULE getSTUDY_SCHEDULE() { 159 CSU_C09_STUDY_SCHEDULE retVal = getTyped("STUDY_SCHEDULE", CSU_C09_STUDY_SCHEDULE.class); 160 return retVal; 161 } 162 163 164 /** 165 * Returns a specific repetition of 166 * STUDY_SCHEDULE (a Group object) - creates it if necessary 167 * 168 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 169 * @throws HL7Exception if the repetition requested is more than one 170 * greater than the number of existing repetitions. 171 */ 172 public CSU_C09_STUDY_SCHEDULE getSTUDY_SCHEDULE(int rep) { 173 CSU_C09_STUDY_SCHEDULE retVal = getTyped("STUDY_SCHEDULE", rep, CSU_C09_STUDY_SCHEDULE.class); 174 return retVal; 175 } 176 177 /** 178 * Returns the number of existing repetitions of STUDY_SCHEDULE 179 */ 180 public int getSTUDY_SCHEDULEReps() { 181 return getReps("STUDY_SCHEDULE"); 182 } 183 184 /** 185 * <p> 186 * Returns a non-modifiable List containing all current existing repetitions of STUDY_SCHEDULE. 187 * <p> 188 * <p> 189 * Note that unlike {@link #getSTUDY_SCHEDULE()}, this method will not create any reps 190 * if none are already present, so an empty list may be returned. 191 * </p> 192 */ 193 public java.util.List<CSU_C09_STUDY_SCHEDULE> getSTUDY_SCHEDULEAll() throws HL7Exception { 194 return getAllAsList("STUDY_SCHEDULE", CSU_C09_STUDY_SCHEDULE.class); 195 } 196 197 /** 198 * Inserts a specific repetition of STUDY_SCHEDULE (a Group object) 199 * @see AbstractGroup#insertRepetition(Structure, int) 200 */ 201 public void insertSTUDY_SCHEDULE(CSU_C09_STUDY_SCHEDULE structure, int rep) throws HL7Exception { 202 super.insertRepetition("STUDY_SCHEDULE", structure, rep); 203 } 204 205 206 /** 207 * Inserts a specific repetition of STUDY_SCHEDULE (a Group object) 208 * @see AbstractGroup#insertRepetition(Structure, int) 209 */ 210 public CSU_C09_STUDY_SCHEDULE insertSTUDY_SCHEDULE(int rep) throws HL7Exception { 211 return (CSU_C09_STUDY_SCHEDULE)super.insertRepetition("STUDY_SCHEDULE", rep); 212 } 213 214 215 /** 216 * Removes a specific repetition of STUDY_SCHEDULE (a Group object) 217 * @see AbstractGroup#removeRepetition(String, int) 218 */ 219 public CSU_C09_STUDY_SCHEDULE removeSTUDY_SCHEDULE(int rep) throws HL7Exception { 220 return (CSU_C09_STUDY_SCHEDULE)super.removeRepetition("STUDY_SCHEDULE", rep); 221 } 222 223 224 225 } 226