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