1 /* 2 * This class is an auto-generated source file for a HAPI 3 * HL7 v2.x standard structure class. 4 * 5 * For more information, visit: http://hl7api.sourceforge.net/ 6 * 7 * The contents of this file are subject to the Mozilla Public License Version 1.1 8 * (the "License"); you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 10 * Software distributed under the License is distributed on an "AS IS" basis, 11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 12 * specific language governing rights and limitations under the License. 13 * 14 * The Original Code is "[file_name]". Description: 15 * "[one_line_description]" 16 * 17 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 18 * 2012. All Rights Reserved. 19 * 20 * Contributor(s): ______________________________________. 21 * 22 * Alternatively, the contents of this file may be used under the terms of the 23 * GNU General Public License (the "GPL"), in which case the provisions of the GPL are 24 * applicable instead of those above. If you wish to allow use of your version of this 25 * file only under the terms of the GPL and not to allow others to use your version 26 * of this file under the MPL, indicate your decision by deleting the provisions above 27 * and replace them with the notice and other provisions required by the GPL License. 28 * If you do not delete the provisions above, a recipient may use your version of 29 * this file under either the MPL or the GPL. 30 * 31 */ 32 33 34 package ca.uhn.hl7v2.model.v27.group; 35 36 import ca.uhn.hl7v2.model.v27.segment.*; 37 38 import ca.uhn.hl7v2.HL7Exception; 39 import ca.uhn.hl7v2.parser.ModelClassFactory; 40 import ca.uhn.hl7v2.model.*; 41 42 /** 43 * <p>Represents a SRM_S01_PERSONNEL_RESOURCE group structure (a Group object). 44 * A Group is an ordered collection of message segments that can repeat together or be optionally in/excluded together. 45 * This Group contains the following elements: 46 * </p> 47 * <ul> 48 * <li>1: AIP (Appointment Information - Personnel Resource) <b> </b></li> 49 * <li>2: APR (Appointment Preferences) <b>optional </b></li> 50 * <li>3: NTE (Notes and Comments) <b>optional repeating </b></li> 51 * </ul> 52 */ 53 //@SuppressWarnings("unused") 54 public class SRM_S01_PERSONNEL_RESOURCE extends AbstractGroup { 55 56 /** 57 * Creates a new SRM_S01_PERSONNEL_RESOURCE group 58 */ 59 public SRM_S01_PERSONNEL_RESOURCE(Group parent, ModelClassFactory factory) { 60 super(parent, factory); 61 init(factory); 62 } 63 64 private void init(ModelClassFactory factory) { 65 try { 66 this.add(AIP.class, true, false, false); 67 this.add(APR.class, false, false, false); 68 this.add(NTE.class, false, true, false); 69 } catch(HL7Exception e) { 70 log.error("Unexpected error creating SRM_S01_PERSONNEL_RESOURCE - this is probably a bug in the source code generator.", e); 71 } 72 } 73 74 /** 75 * Returns "2.7" 76 */ 77 public String getVersion() { 78 return "2.7"; 79 } 80 81 82 83 /** 84 * Returns 85 * AIP (Appointment Information - Personnel Resource) - creates it if necessary 86 */ 87 public AIP getAIP() { 88 AIP retVal = getTyped("AIP", AIP.class); 89 return retVal; 90 } 91 92 93 94 95 /** 96 * Returns 97 * APR (Appointment Preferences) - creates it if necessary 98 */ 99 public APR getAPR() { 100 APR retVal = getTyped("APR", APR.class); 101 return retVal; 102 } 103 104 105 106 107 /** 108 * Returns 109 * the first repetition of 110 * NTE (Notes and Comments) - creates it if necessary 111 */ 112 public NTE getNTE() { 113 NTE retVal = getTyped("NTE", NTE.class); 114 return retVal; 115 } 116 117 118 /** 119 * Returns a specific repetition of 120 * NTE (Notes and Comments) - creates it if necessary 121 * 122 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 123 * @throws HL7Exception if the repetition requested is more than one 124 * greater than the number of existing repetitions. 125 */ 126 public NTE getNTE(int rep) { 127 NTE retVal = getTyped("NTE", rep, NTE.class); 128 return retVal; 129 } 130 131 /** 132 * Returns the number of existing repetitions of NTE 133 */ 134 public int getNTEReps() { 135 return getReps("NTE"); 136 } 137 138 /** 139 * <p> 140 * Returns a non-modifiable List containing all current existing repetitions of NTE. 141 * <p> 142 * <p> 143 * Note that unlike {@link #getNTE()}, this method will not create any reps 144 * if none are already present, so an empty list may be returned. 145 * </p> 146 */ 147 public java.util.List<NTE> getNTEAll() throws HL7Exception { 148 return getAllAsList("NTE", NTE.class); 149 } 150 151 /** 152 * Inserts a specific repetition of NTE (Notes and Comments) 153 * @see AbstractGroup#insertRepetition(Structure, int) 154 */ 155 public void insertNTE(NTE structure, int rep) throws HL7Exception { 156 super.insertRepetition("NTE", structure, rep); 157 } 158 159 160 /** 161 * Inserts a specific repetition of NTE (Notes and Comments) 162 * @see AbstractGroup#insertRepetition(Structure, int) 163 */ 164 public NTE insertNTE(int rep) throws HL7Exception { 165 return (NTE)super.insertRepetition("NTE", rep); 166 } 167 168 169 /** 170 * Removes a specific repetition of NTE (Notes and Comments) 171 * @see AbstractGroup#removeRepetition(String, int) 172 */ 173 public NTE removeNTE(int rep) throws HL7Exception { 174 return (NTE)super.removeRepetition("NTE", rep); 175 } 176 177 178 179 } 180