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.v23.group; 035 036import ca.uhn.hl7v2.model.v23.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a RDR_RDR_DEFINITION 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: QRD (Query definition segment) <b> </b></li> 049 * <li>2: QRF (Query filter segment) <b>optional </b></li> 050 * <li>3: RDR_RDR_PATIENT (a Group object) <b>optional </b></li> 051 * <li>4: RDR_RDR_ORDER (a Group object) <b> repeating </b></li> 052 * </ul> 053 */ 054//@SuppressWarnings("unused") 055public class RDR_RDR_DEFINITION extends AbstractGroup { 056 057 /** 058 * Creates a new RDR_RDR_DEFINITION group 059 */ 060 public RDR_RDR_DEFINITION(Group parent, ModelClassFactory factory) { 061 super(parent, factory); 062 init(factory); 063 } 064 065 private void init(ModelClassFactory factory) { 066 try { 067 this.add(QRD.class, true, false, false); 068 this.add(QRF.class, false, false, false); 069 this.add(RDR_RDR_PATIENT.class, false, false, false); 070 this.add(RDR_RDR_ORDER.class, true, true, false); 071 } catch(HL7Exception e) { 072 log.error("Unexpected error creating RDR_RDR_DEFINITION - this is probably a bug in the source code generator.", e); 073 } 074 } 075 076 /** 077 * Returns "2.3" 078 */ 079 public String getVersion() { 080 return "2.3"; 081 } 082 083 084 085 /** 086 * Returns 087 * QRD (Query definition segment) - creates it if necessary 088 */ 089 public QRD getQRD() { 090 QRD retVal = getTyped("QRD", QRD.class); 091 return retVal; 092 } 093 094 095 096 097 /** 098 * Returns 099 * QRF (Query filter segment) - creates it if necessary 100 */ 101 public QRF getQRF() { 102 QRF retVal = getTyped("QRF", QRF.class); 103 return retVal; 104 } 105 106 107 108 109 /** 110 * Returns 111 * PATIENT (a Group object) - creates it if necessary 112 */ 113 public RDR_RDR_PATIENT getPATIENT() { 114 RDR_RDR_PATIENT retVal = getTyped("PATIENT", RDR_RDR_PATIENT.class); 115 return retVal; 116 } 117 118 119 120 121 /** 122 * Returns 123 * the first repetition of 124 * ORDER (a Group object) - creates it if necessary 125 */ 126 public RDR_RDR_ORDER getORDER() { 127 RDR_RDR_ORDER retVal = getTyped("ORDER", RDR_RDR_ORDER.class); 128 return retVal; 129 } 130 131 132 /** 133 * Returns a specific repetition of 134 * ORDER (a Group object) - creates it if necessary 135 * 136 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 137 * @throws HL7Exception if the repetition requested is more than one 138 * greater than the number of existing repetitions. 139 */ 140 public RDR_RDR_ORDER getORDER(int rep) { 141 RDR_RDR_ORDER retVal = getTyped("ORDER", rep, RDR_RDR_ORDER.class); 142 return retVal; 143 } 144 145 /** 146 * Returns the number of existing repetitions of ORDER 147 */ 148 public int getORDERReps() { 149 return getReps("ORDER"); 150 } 151 152 /** 153 * <p> 154 * Returns a non-modifiable List containing all current existing repetitions of ORDER. 155 * <p> 156 * <p> 157 * Note that unlike {@link #getORDER()}, this method will not create any reps 158 * if none are already present, so an empty list may be returned. 159 * </p> 160 */ 161 public java.util.List<RDR_RDR_ORDER> getORDERAll() throws HL7Exception { 162 return getAllAsList("ORDER", RDR_RDR_ORDER.class); 163 } 164 165 /** 166 * Inserts a specific repetition of ORDER (a Group object) 167 * @see AbstractGroup#insertRepetition(Structure, int) 168 */ 169 public void insertORDER(RDR_RDR_ORDER structure, int rep) throws HL7Exception { 170 super.insertRepetition("ORDER", structure, rep); 171 } 172 173 174 /** 175 * Inserts a specific repetition of ORDER (a Group object) 176 * @see AbstractGroup#insertRepetition(Structure, int) 177 */ 178 public RDR_RDR_ORDER insertORDER(int rep) throws HL7Exception { 179 return (RDR_RDR_ORDER)super.insertRepetition("ORDER", rep); 180 } 181 182 183 /** 184 * Removes a specific repetition of ORDER (a Group object) 185 * @see AbstractGroup#removeRepetition(String, int) 186 */ 187 public RDR_RDR_ORDER removeORDER(int rep) throws HL7Exception { 188 return (RDR_RDR_ORDER)super.removeRepetition("ORDER", rep); 189 } 190 191 192 193} 194