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.v27.group; 035 036import ca.uhn.hl7v2.model.v27.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a OPL_O37_ORDER_PRIOR group structure (a Group object). 044 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 045 * This Group contains the following elements: 046 * </p> 047 * <ul> 048 * <li>1: OBR (Observation Request) <b> </b></li> 049 * <li>2: ORC (Common Order) <b>optional </b></li> 050 * <li>3: PRT (Participation Information) <b>optional repeating </b></li> 051 * <li>4: OPL_O37_TIMING2 (a Group object) <b>optional </b></li> 052 * <li>5: OPL_O37_OBSERVATION_RESULT_GROUP (a Group object) <b> repeating </b></li> 053 * </ul> 054 */ 055//@SuppressWarnings("unused") 056public class OPL_O37_ORDER_PRIOR extends AbstractGroup { 057 058 /** 059 * Creates a new OPL_O37_ORDER_PRIOR group 060 */ 061 public OPL_O37_ORDER_PRIOR(Group parent, ModelClassFactory factory) { 062 super(parent, factory); 063 init(factory); 064 } 065 066 private void init(ModelClassFactory factory) { 067 try { 068 this.add(OBR.class, true, false, false); 069 this.add(ORC.class, false, false, false); 070 this.add(PRT.class, false, true, false); 071 this.add(OPL_O37_TIMING2.class, false, false, false); 072 this.add(OPL_O37_OBSERVATION_RESULT_GROUP.class, true, true, false); 073 } catch(HL7Exception e) { 074 log.error("Unexpected error creating OPL_O37_ORDER_PRIOR - this is probably a bug in the source code generator.", e); 075 } 076 } 077 078 /** 079 * Returns "2.7" 080 */ 081 public String getVersion() { 082 return "2.7"; 083 } 084 085 086 087 /** 088 * Returns 089 * OBR (Observation Request) - creates it if necessary 090 */ 091 public OBR getOBR() { 092 OBR retVal = getTyped("OBR", OBR.class); 093 return retVal; 094 } 095 096 097 098 099 /** 100 * Returns 101 * ORC (Common Order) - creates it if necessary 102 */ 103 public ORC getORC() { 104 ORC retVal = getTyped("ORC", ORC.class); 105 return retVal; 106 } 107 108 109 110 111 /** 112 * Returns 113 * the first repetition of 114 * PRT (Participation Information) - creates it if necessary 115 */ 116 public PRT getPRT() { 117 PRT retVal = getTyped("PRT", PRT.class); 118 return retVal; 119 } 120 121 122 /** 123 * Returns a specific repetition of 124 * PRT (Participation Information) - creates it if necessary 125 * 126 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 127 * @throws HL7Exception if the repetition requested is more than one 128 * greater than the number of existing repetitions. 129 */ 130 public PRT getPRT(int rep) { 131 PRT retVal = getTyped("PRT", rep, PRT.class); 132 return retVal; 133 } 134 135 /** 136 * Returns the number of existing repetitions of PRT 137 */ 138 public int getPRTReps() { 139 return getReps("PRT"); 140 } 141 142 /** 143 * <p> 144 * Returns a non-modifiable List containing all current existing repetitions of PRT. 145 * <p> 146 * <p> 147 * Note that unlike {@link #getPRT()}, this method will not create any reps 148 * if none are already present, so an empty list may be returned. 149 * </p> 150 */ 151 public java.util.List<PRT> getPRTAll() throws HL7Exception { 152 return getAllAsList("PRT", PRT.class); 153 } 154 155 /** 156 * Inserts a specific repetition of PRT (Participation Information) 157 * @see AbstractGroup#insertRepetition(Structure, int) 158 */ 159 public void insertPRT(PRT structure, int rep) throws HL7Exception { 160 super.insertRepetition("PRT", structure, rep); 161 } 162 163 164 /** 165 * Inserts a specific repetition of PRT (Participation Information) 166 * @see AbstractGroup#insertRepetition(Structure, int) 167 */ 168 public PRT insertPRT(int rep) throws HL7Exception { 169 return (PRT)super.insertRepetition("PRT", rep); 170 } 171 172 173 /** 174 * Removes a specific repetition of PRT (Participation Information) 175 * @see AbstractGroup#removeRepetition(String, int) 176 */ 177 public PRT removePRT(int rep) throws HL7Exception { 178 return (PRT)super.removeRepetition("PRT", rep); 179 } 180 181 182 183 /** 184 * Returns 185 * TIMING2 (a Group object) - creates it if necessary 186 */ 187 public OPL_O37_TIMING2 getTIMING2() { 188 OPL_O37_TIMING2 retVal = getTyped("TIMING2", OPL_O37_TIMING2.class); 189 return retVal; 190 } 191 192 193 194 195 /** 196 * Returns 197 * the first repetition of 198 * OBSERVATION_RESULT_GROUP (a Group object) - creates it if necessary 199 */ 200 public OPL_O37_OBSERVATION_RESULT_GROUP getOBSERVATION_RESULT_GROUP() { 201 OPL_O37_OBSERVATION_RESULT_GROUP retVal = getTyped("OBSERVATION_RESULT_GROUP", OPL_O37_OBSERVATION_RESULT_GROUP.class); 202 return retVal; 203 } 204 205 206 /** 207 * Returns a specific repetition of 208 * OBSERVATION_RESULT_GROUP (a Group object) - 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 OPL_O37_OBSERVATION_RESULT_GROUP getOBSERVATION_RESULT_GROUP(int rep) { 215 OPL_O37_OBSERVATION_RESULT_GROUP retVal = getTyped("OBSERVATION_RESULT_GROUP", rep, OPL_O37_OBSERVATION_RESULT_GROUP.class); 216 return retVal; 217 } 218 219 /** 220 * Returns the number of existing repetitions of OBSERVATION_RESULT_GROUP 221 */ 222 public int getOBSERVATION_RESULT_GROUPReps() { 223 return getReps("OBSERVATION_RESULT_GROUP"); 224 } 225 226 /** 227 * <p> 228 * Returns a non-modifiable List containing all current existing repetitions of OBSERVATION_RESULT_GROUP. 229 * <p> 230 * <p> 231 * Note that unlike {@link #getOBSERVATION_RESULT_GROUP()}, 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<OPL_O37_OBSERVATION_RESULT_GROUP> getOBSERVATION_RESULT_GROUPAll() throws HL7Exception { 236 return getAllAsList("OBSERVATION_RESULT_GROUP", OPL_O37_OBSERVATION_RESULT_GROUP.class); 237 } 238 239 /** 240 * Inserts a specific repetition of OBSERVATION_RESULT_GROUP (a Group object) 241 * @see AbstractGroup#insertRepetition(Structure, int) 242 */ 243 public void insertOBSERVATION_RESULT_GROUP(OPL_O37_OBSERVATION_RESULT_GROUP structure, int rep) throws HL7Exception { 244 super.insertRepetition("OBSERVATION_RESULT_GROUP", structure, rep); 245 } 246 247 248 /** 249 * Inserts a specific repetition of OBSERVATION_RESULT_GROUP (a Group object) 250 * @see AbstractGroup#insertRepetition(Structure, int) 251 */ 252 public OPL_O37_OBSERVATION_RESULT_GROUP insertOBSERVATION_RESULT_GROUP(int rep) throws HL7Exception { 253 return (OPL_O37_OBSERVATION_RESULT_GROUP)super.insertRepetition("OBSERVATION_RESULT_GROUP", rep); 254 } 255 256 257 /** 258 * Removes a specific repetition of OBSERVATION_RESULT_GROUP (a Group object) 259 * @see AbstractGroup#removeRepetition(String, int) 260 */ 261 public OPL_O37_OBSERVATION_RESULT_GROUP removeOBSERVATION_RESULT_GROUP(int rep) throws HL7Exception { 262 return (OPL_O37_OBSERVATION_RESULT_GROUP)super.removeRepetition("OBSERVATION_RESULT_GROUP", rep); 263 } 264 265 266 267} 268