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.v231.segment; 035 036// import ca.uhn.hl7v2.model.v231.group.*; 037import ca.uhn.hl7v2.model.v231.datatype.*; 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 041import ca.uhn.hl7v2.model.AbstractMessage; 042import ca.uhn.hl7v2.model.Group; 043import ca.uhn.hl7v2.model.Type; 044import ca.uhn.hl7v2.model.AbstractSegment; 045import ca.uhn.hl7v2.model.Varies; 046 047 048/** 049 *<p>Represents an HL7 LRL message segment (LRL - location relationship segment). 050 * This segment has the following fields:</p> 051 * <ul> 052 * <li>LRL-1: Primary Key Value - LRL (PL) <b> </b> 053 * <li>LRL-2: Segment Action Code (ID) <b>optional </b> 054 * <li>LRL-3: Segment Unique Key (EI) <b>optional </b> 055 * <li>LRL-4: Location Relationship ID (CE) <b>optional </b> 056 * <li>LRL-5: Organizational Location Relationship Value (XON) <b>optional repeating</b> 057 * <li>LRL-6: Patient Location Relationship Value (PL) <b>optional </b> 058 * </ul> 059 */ 060@SuppressWarnings("unused") 061public class LRL extends AbstractSegment { 062 063 /** 064 * Creates a new LRL segment 065 */ 066 public LRL(Group parent, ModelClassFactory factory) { 067 super(parent, factory); 068 init(factory); 069 } 070 071 private void init(ModelClassFactory factory) { 072 try { 073 this.add(PL.class, true, 1, 200, new Object[]{ getMessage() }, "Primary Key Value - LRL"); 074 this.add(ID.class, false, 1, 3, new Object[]{ getMessage(), new Integer(206) }, "Segment Action Code"); 075 this.add(EI.class, false, 1, 80, new Object[]{ getMessage() }, "Segment Unique Key"); 076 this.add(CE.class, false, 1, 80, new Object[]{ getMessage() }, "Location Relationship ID"); 077 this.add(XON.class, false, 0, 80, new Object[]{ getMessage() }, "Organizational Location Relationship Value"); 078 this.add(PL.class, false, 1, 80, new Object[]{ getMessage() }, "Patient Location Relationship Value"); 079 } catch(HL7Exception e) { 080 log.error("Unexpected error creating LRL - this is probably a bug in the source code generator.", e); 081 } 082 } 083 084 085 086 /** 087 * Returns 088 * LRL-1: "Primary Key Value - LRL" - creates it if necessary 089 */ 090 public PL getPrimaryKeyValueLRL() { 091 PL retVal = this.getTypedField(1, 0); 092 return retVal; 093 } 094 095 /** 096 * Returns 097 * LRL-1: "Primary Key Value - LRL" - creates it if necessary 098 */ 099 public PL getLrl1_PrimaryKeyValueLRL() { 100 PL retVal = this.getTypedField(1, 0); 101 return retVal; 102 } 103 104 105 106 /** 107 * Returns 108 * LRL-2: "Segment Action Code" - creates it if necessary 109 */ 110 public ID getSegmentActionCode() { 111 ID retVal = this.getTypedField(2, 0); 112 return retVal; 113 } 114 115 /** 116 * Returns 117 * LRL-2: "Segment Action Code" - creates it if necessary 118 */ 119 public ID getLrl2_SegmentActionCode() { 120 ID retVal = this.getTypedField(2, 0); 121 return retVal; 122 } 123 124 125 126 /** 127 * Returns 128 * LRL-3: "Segment Unique Key" - creates it if necessary 129 */ 130 public EI getSegmentUniqueKey() { 131 EI retVal = this.getTypedField(3, 0); 132 return retVal; 133 } 134 135 /** 136 * Returns 137 * LRL-3: "Segment Unique Key" - creates it if necessary 138 */ 139 public EI getLrl3_SegmentUniqueKey() { 140 EI retVal = this.getTypedField(3, 0); 141 return retVal; 142 } 143 144 145 146 /** 147 * Returns 148 * LRL-4: "Location Relationship ID" - creates it if necessary 149 */ 150 public CE getLocationRelationshipID() { 151 CE retVal = this.getTypedField(4, 0); 152 return retVal; 153 } 154 155 /** 156 * Returns 157 * LRL-4: "Location Relationship ID" - creates it if necessary 158 */ 159 public CE getLrl4_LocationRelationshipID() { 160 CE retVal = this.getTypedField(4, 0); 161 return retVal; 162 } 163 164 165 /** 166 * Returns all repetitions of Organizational Location Relationship Value (LRL-5). 167 */ 168 public XON[] getOrganizationalLocationRelationshipValue() { 169 XON[] retVal = this.getTypedField(5, new XON[0]); 170 return retVal; 171 } 172 173 174 /** 175 * Returns all repetitions of Organizational Location Relationship Value (LRL-5). 176 */ 177 public XON[] getLrl5_OrganizationalLocationRelationshipValue() { 178 XON[] retVal = this.getTypedField(5, new XON[0]); 179 return retVal; 180 } 181 182 183 /** 184 * Returns a count of the current number of repetitions of Organizational Location Relationship Value (LRL-5). 185 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 186 * it will return zero. 187 */ 188 public int getOrganizationalLocationRelationshipValueReps() { 189 return this.getReps(5); 190 } 191 192 193 /** 194 * Returns a specific repetition of 195 * LRL-5: "Organizational Location Relationship Value" - creates it if necessary 196 * 197 * @param rep The repetition index (0-indexed) 198 */ 199 public XON getOrganizationalLocationRelationshipValue(int rep) { 200 XON retVal = this.getTypedField(5, rep); 201 return retVal; 202 } 203 204 /** 205 * Returns a specific repetition of 206 * LRL-5: "Organizational Location Relationship Value" - creates it if necessary 207 * 208 * @param rep The repetition index (0-indexed) 209 */ 210 public XON getLrl5_OrganizationalLocationRelationshipValue(int rep) { 211 XON retVal = this.getTypedField(5, rep); 212 return retVal; 213 } 214 215 /** 216 * Returns a count of the current number of repetitions of Organizational Location Relationship Value (LRL-5). 217 * This method does not create a repetition, so if no repetitions have currently been defined or accessed, 218 * it will return zero. 219 */ 220 public int getLrl5_OrganizationalLocationRelationshipValueReps() { 221 return this.getReps(5); 222 } 223 224 225 /** 226 * Inserts a repetition of 227 * LRL-5: "Organizational Location Relationship Value" at a specific index 228 * 229 * @param rep The repetition index (0-indexed) 230 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 231 */ 232 public XON insertOrganizationalLocationRelationshipValue(int rep) throws HL7Exception { 233 return (XON) super.insertRepetition(5, rep); 234 } 235 236 237 /** 238 * Inserts a repetition of 239 * LRL-5: "Organizational Location Relationship Value" at a specific index 240 * 241 * @param rep The repetition index (0-indexed) 242 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 243 */ 244 public XON insertLrl5_OrganizationalLocationRelationshipValue(int rep) throws HL7Exception { 245 return (XON) super.insertRepetition(5, rep); 246 } 247 248 249 /** 250 * Removes a repetition of 251 * LRL-5: "Organizational Location Relationship Value" at a specific index 252 * 253 * @param rep The repetition index (0-indexed) 254 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 255 */ 256 public XON removeOrganizationalLocationRelationshipValue(int rep) throws HL7Exception { 257 return (XON) super.removeRepetition(5, rep); 258 } 259 260 261 /** 262 * Removes a repetition of 263 * LRL-5: "Organizational Location Relationship Value" at a specific index 264 * 265 * @param rep The repetition index (0-indexed) 266 * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions) 267 */ 268 public XON removeLrl5_OrganizationalLocationRelationshipValue(int rep) throws HL7Exception { 269 return (XON) super.removeRepetition(5, rep); 270 } 271 272 273 274 275 /** 276 * Returns 277 * LRL-6: "Patient Location Relationship Value" - creates it if necessary 278 */ 279 public PL getPatientLocationRelationshipValue() { 280 PL retVal = this.getTypedField(6, 0); 281 return retVal; 282 } 283 284 /** 285 * Returns 286 * LRL-6: "Patient Location Relationship Value" - creates it if necessary 287 */ 288 public PL getLrl6_PatientLocationRelationshipValue() { 289 PL retVal = this.getTypedField(6, 0); 290 return retVal; 291 } 292 293 294 295 296 297 /** {@inheritDoc} */ 298 protected Type createNewTypeWithoutReflection(int field) { 299 switch (field) { 300 case 0: return new PL(getMessage()); 301 case 1: return new ID(getMessage(), new Integer( 206 )); 302 case 2: return new EI(getMessage()); 303 case 3: return new CE(getMessage()); 304 case 4: return new XON(getMessage()); 305 case 5: return new PL(getMessage()); 306 default: return null; 307 } 308 } 309 310 311} 312