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.v26.group; 35 36 import ca.uhn.hl7v2.model.v26.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 RDR_RDR_DEFINITION 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: QRD (Original-Style Query Definition) <b> </b></li> 49 * <li>2: QRF (Original style query filter) <b>optional </b></li> 50 * <li>3: RDR_RDR_PATIENT (a Group object) <b>optional </b></li> 51 * <li>4: RDR_RDR_ORDER (a Group object) <b> repeating </b></li> 52 * <li>5: RXR (Pharmacy/Treatment Route) <b> repeating </b></li> 53 * </ul> 54 */ 55 //@SuppressWarnings("unused") 56 public class RDR_RDR_DEFINITION extends AbstractGroup { 57 58 /** 59 * Creates a new RDR_RDR_DEFINITION group 60 */ 61 public RDR_RDR_DEFINITION(Group parent, ModelClassFactory factory) { 62 super(parent, factory); 63 init(factory); 64 } 65 66 private void init(ModelClassFactory factory) { 67 try { 68 this.add(QRD.class, true, false, false); 69 this.add(QRF.class, false, false, false); 70 this.add(RDR_RDR_PATIENT.class, false, false, false); 71 this.add(RDR_RDR_ORDER.class, true, true, false); 72 this.add(RXR.class, true, true, false); 73 } catch(HL7Exception e) { 74 log.error("Unexpected error creating RDR_RDR_DEFINITION - this is probably a bug in the source code generator.", e); 75 } 76 } 77 78 /** 79 * Returns "2.6" 80 */ 81 public String getVersion() { 82 return "2.6"; 83 } 84 85 86 87 /** 88 * Returns 89 * QRD (Original-Style Query Definition) - creates it if necessary 90 */ 91 public QRD getQRD() { 92 QRD retVal = getTyped("QRD", QRD.class); 93 return retVal; 94 } 95 96 97 98 99 /** 100 * Returns 101 * QRF (Original style query filter) - creates it if necessary 102 */ 103 public QRF getQRF() { 104 QRF retVal = getTyped("QRF", QRF.class); 105 return retVal; 106 } 107 108 109 110 111 /** 112 * Returns 113 * PATIENT (a Group object) - creates it if necessary 114 */ 115 public RDR_RDR_PATIENT getPATIENT() { 116 RDR_RDR_PATIENT retVal = getTyped("PATIENT", RDR_RDR_PATIENT.class); 117 return retVal; 118 } 119 120 121 122 123 /** 124 * Returns 125 * the first repetition of 126 * ORDER (a Group object) - creates it if necessary 127 */ 128 public RDR_RDR_ORDER getORDER() { 129 RDR_RDR_ORDER retVal = getTyped("ORDER", RDR_RDR_ORDER.class); 130 return retVal; 131 } 132 133 134 /** 135 * Returns a specific repetition of 136 * ORDER (a Group object) - creates it if necessary 137 * 138 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 139 * @throws HL7Exception if the repetition requested is more than one 140 * greater than the number of existing repetitions. 141 */ 142 public RDR_RDR_ORDER getORDER(int rep) { 143 RDR_RDR_ORDER retVal = getTyped("ORDER", rep, RDR_RDR_ORDER.class); 144 return retVal; 145 } 146 147 /** 148 * Returns the number of existing repetitions of ORDER 149 */ 150 public int getORDERReps() { 151 return getReps("ORDER"); 152 } 153 154 /** 155 * <p> 156 * Returns a non-modifiable List containing all current existing repetitions of ORDER. 157 * <p> 158 * <p> 159 * Note that unlike {@link #getORDER()}, this method will not create any reps 160 * if none are already present, so an empty list may be returned. 161 * </p> 162 */ 163 public java.util.List<RDR_RDR_ORDER> getORDERAll() throws HL7Exception { 164 return getAllAsList("ORDER", RDR_RDR_ORDER.class); 165 } 166 167 /** 168 * Inserts a specific repetition of ORDER (a Group object) 169 * @see AbstractGroup#insertRepetition(Structure, int) 170 */ 171 public void insertORDER(RDR_RDR_ORDER structure, int rep) throws HL7Exception { 172 super.insertRepetition("ORDER", structure, rep); 173 } 174 175 176 /** 177 * Inserts a specific repetition of ORDER (a Group object) 178 * @see AbstractGroup#insertRepetition(Structure, int) 179 */ 180 public RDR_RDR_ORDER insertORDER(int rep) throws HL7Exception { 181 return (RDR_RDR_ORDER)super.insertRepetition("ORDER", rep); 182 } 183 184 185 /** 186 * Removes a specific repetition of ORDER (a Group object) 187 * @see AbstractGroup#removeRepetition(String, int) 188 */ 189 public RDR_RDR_ORDER removeORDER(int rep) throws HL7Exception { 190 return (RDR_RDR_ORDER)super.removeRepetition("ORDER", rep); 191 } 192 193 194 195 /** 196 * Returns 197 * the first repetition of 198 * RXR (Pharmacy/Treatment Route) - creates it if necessary 199 */ 200 public RXR getRXR() { 201 RXR retVal = getTyped("RXR", RXR.class); 202 return retVal; 203 } 204 205 206 /** 207 * Returns a specific repetition of 208 * RXR (Pharmacy/Treatment Route) - creates it if necessary 209 * 210 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 211 * @throws HL7Exception if the repetition requested is more than one 212 * greater than the number of existing repetitions. 213 */ 214 public RXR getRXR(int rep) { 215 RXR retVal = getTyped("RXR", rep, RXR.class); 216 return retVal; 217 } 218 219 /** 220 * Returns the number of existing repetitions of RXR 221 */ 222 public int getRXRReps() { 223 return getReps("RXR"); 224 } 225 226 /** 227 * <p> 228 * Returns a non-modifiable List containing all current existing repetitions of RXR. 229 * <p> 230 * <p> 231 * Note that unlike {@link #getRXR()}, this method will not create any reps 232 * if none are already present, so an empty list may be returned. 233 * </p> 234 */ 235 public java.util.List<RXR> getRXRAll() throws HL7Exception { 236 return getAllAsList("RXR", RXR.class); 237 } 238 239 /** 240 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 241 * @see AbstractGroup#insertRepetition(Structure, int) 242 */ 243 public void insertRXR(RXR structure, int rep) throws HL7Exception { 244 super.insertRepetition("RXR", structure, rep); 245 } 246 247 248 /** 249 * Inserts a specific repetition of RXR (Pharmacy/Treatment Route) 250 * @see AbstractGroup#insertRepetition(Structure, int) 251 */ 252 public RXR insertRXR(int rep) throws HL7Exception { 253 return (RXR)super.insertRepetition("RXR", rep); 254 } 255 256 257 /** 258 * Removes a specific repetition of RXR (Pharmacy/Treatment Route) 259 * @see AbstractGroup#removeRepetition(String, int) 260 */ 261 public RXR removeRXR(int rep) throws HL7Exception { 262 return (RXR)super.removeRepetition("RXR", rep); 263 } 264 265 266 267 } 268