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.group; 035 036import ca.uhn.hl7v2.model.v231.segment.*; 037 038import ca.uhn.hl7v2.HL7Exception; 039import ca.uhn.hl7v2.parser.ModelClassFactory; 040import ca.uhn.hl7v2.model.*; 041 042/** 043 * <p>Represents a RAS_O01_NTERXRRXCNTE 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: NTE (NTE - notes and comments segment) <b> repeating </b></li> 049 * <li>2: RXR (RXR - pharmacy/treatment route segment) <b> repeating </b></li> 050 * <li>3: RAS_O01_RXCNTE (a Group object) <b>optional </b></li> 051 * </ul> 052 */ 053//@SuppressWarnings("unused") 054public class RAS_O01_NTERXRRXCNTE extends AbstractGroup { 055 056 /** 057 * Creates a new RAS_O01_NTERXRRXCNTE group 058 */ 059 public RAS_O01_NTERXRRXCNTE(Group parent, ModelClassFactory factory) { 060 super(parent, factory); 061 init(factory); 062 } 063 064 private void init(ModelClassFactory factory) { 065 try { 066 this.add(NTE.class, true, true, false); 067 this.add(RXR.class, true, true, false); 068 this.add(RAS_O01_RXCNTE.class, false, false, false); 069 } catch(HL7Exception e) { 070 log.error("Unexpected error creating RAS_O01_NTERXRRXCNTE - this is probably a bug in the source code generator.", e); 071 } 072 } 073 074 /** 075 * Returns "2.3.1" 076 */ 077 public String getVersion() { 078 return "2.3.1"; 079 } 080 081 082 083 /** 084 * Returns 085 * the first repetition of 086 * NTE (NTE - notes and comments segment) - creates it if necessary 087 */ 088 public NTE getNTE() { 089 NTE retVal = getTyped("NTE", NTE.class); 090 return retVal; 091 } 092 093 094 /** 095 * Returns a specific repetition of 096 * NTE (NTE - notes and comments segment) - creates it if necessary 097 * 098 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 099 * @throws HL7Exception if the repetition requested is more than one 100 * greater than the number of existing repetitions. 101 */ 102 public NTE getNTE(int rep) { 103 NTE retVal = getTyped("NTE", rep, NTE.class); 104 return retVal; 105 } 106 107 /** 108 * Returns the number of existing repetitions of NTE 109 */ 110 public int getNTEReps() { 111 return getReps("NTE"); 112 } 113 114 /** 115 * <p> 116 * Returns a non-modifiable List containing all current existing repetitions of NTE. 117 * <p> 118 * <p> 119 * Note that unlike {@link #getNTE()}, this method will not create any reps 120 * if none are already present, so an empty list may be returned. 121 * </p> 122 */ 123 public java.util.List<NTE> getNTEAll() throws HL7Exception { 124 return getAllAsList("NTE", NTE.class); 125 } 126 127 /** 128 * Inserts a specific repetition of NTE (NTE - notes and comments segment) 129 * @see AbstractGroup#insertRepetition(Structure, int) 130 */ 131 public void insertNTE(NTE structure, int rep) throws HL7Exception { 132 super.insertRepetition("NTE", structure, rep); 133 } 134 135 136 /** 137 * Inserts a specific repetition of NTE (NTE - notes and comments segment) 138 * @see AbstractGroup#insertRepetition(Structure, int) 139 */ 140 public NTE insertNTE(int rep) throws HL7Exception { 141 return (NTE)super.insertRepetition("NTE", rep); 142 } 143 144 145 /** 146 * Removes a specific repetition of NTE (NTE - notes and comments segment) 147 * @see AbstractGroup#removeRepetition(String, int) 148 */ 149 public NTE removeNTE(int rep) throws HL7Exception { 150 return (NTE)super.removeRepetition("NTE", rep); 151 } 152 153 154 155 /** 156 * Returns 157 * the first repetition of 158 * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary 159 */ 160 public RXR getRXR() { 161 RXR retVal = getTyped("RXR", RXR.class); 162 return retVal; 163 } 164 165 166 /** 167 * Returns a specific repetition of 168 * RXR (RXR - pharmacy/treatment route segment) - creates it if necessary 169 * 170 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 171 * @throws HL7Exception if the repetition requested is more than one 172 * greater than the number of existing repetitions. 173 */ 174 public RXR getRXR(int rep) { 175 RXR retVal = getTyped("RXR", rep, RXR.class); 176 return retVal; 177 } 178 179 /** 180 * Returns the number of existing repetitions of RXR 181 */ 182 public int getRXRReps() { 183 return getReps("RXR"); 184 } 185 186 /** 187 * <p> 188 * Returns a non-modifiable List containing all current existing repetitions of RXR. 189 * <p> 190 * <p> 191 * Note that unlike {@link #getRXR()}, this method will not create any reps 192 * if none are already present, so an empty list may be returned. 193 * </p> 194 */ 195 public java.util.List<RXR> getRXRAll() throws HL7Exception { 196 return getAllAsList("RXR", RXR.class); 197 } 198 199 /** 200 * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment) 201 * @see AbstractGroup#insertRepetition(Structure, int) 202 */ 203 public void insertRXR(RXR structure, int rep) throws HL7Exception { 204 super.insertRepetition("RXR", structure, rep); 205 } 206 207 208 /** 209 * Inserts a specific repetition of RXR (RXR - pharmacy/treatment route segment) 210 * @see AbstractGroup#insertRepetition(Structure, int) 211 */ 212 public RXR insertRXR(int rep) throws HL7Exception { 213 return (RXR)super.insertRepetition("RXR", rep); 214 } 215 216 217 /** 218 * Removes a specific repetition of RXR (RXR - pharmacy/treatment route segment) 219 * @see AbstractGroup#removeRepetition(String, int) 220 */ 221 public RXR removeRXR(int rep) throws HL7Exception { 222 return (RXR)super.removeRepetition("RXR", rep); 223 } 224 225 226 227 /** 228 * Returns 229 * RXCNTE (a Group object) - creates it if necessary 230 */ 231 public RAS_O01_RXCNTE getRXCNTE() { 232 RAS_O01_RXCNTE retVal = getTyped("RXCNTE", RAS_O01_RXCNTE.class); 233 return retVal; 234 } 235 236 237 238 239} 240