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.v22.message; 35 36 import ca.uhn.hl7v2.model.v22.group.*; 37 import ca.uhn.hl7v2.model.v22.segment.*; 38 39 import ca.uhn.hl7v2.HL7Exception; 40 import ca.uhn.hl7v2.parser.ModelClassFactory; 41 import ca.uhn.hl7v2.parser.DefaultModelClassFactory; 42 import ca.uhn.hl7v2.model.*; 43 44 45 /** 46 * <p>Represents a ORR_O02 message structure (see chapter ?). This structure contains the 47 * following elements: </p> 48 * <ul> 49 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li> 50 * <li>2: MSA (MESSAGE ACKNOWLEDGMENT) <b> </b> </li> 51 * <li>3: NTE (NOTES AND COMMENTS) <b>optional repeating</b> </li> 52 * <li>4: ORR_O02_PATIENT (a Group object) <b>optional </b> </li> 53 * </ul> 54 */ 55 //@SuppressWarnings("unused") 56 public class ORR_O02 extends AbstractMessage { 57 58 /** 59 * Creates a new ORR_O02 message with DefaultModelClassFactory. 60 */ 61 public ORR_O02() { 62 this(new DefaultModelClassFactory()); 63 } 64 65 /** 66 * Creates a new ORR_O02 message with custom ModelClassFactory. 67 */ 68 public ORR_O02(ModelClassFactory factory) { 69 super(factory); 70 init(factory); 71 } 72 73 private void init(ModelClassFactory factory) { 74 try { 75 this.add(MSH.class, true, false); 76 this.add(MSA.class, true, false); 77 this.add(NTE.class, false, true); 78 this.add(ORR_O02_PATIENT.class, false, false); 79 } catch(HL7Exception e) { 80 log.error("Unexpected error creating ORR_O02 - this is probably a bug in the source code generator.", e); 81 } 82 } 83 84 85 /** 86 * Returns "2.2" 87 */ 88 public String getVersion() { 89 return "2.2"; 90 } 91 92 93 94 95 /** 96 * <p> 97 * Returns 98 * MSH (MESSAGE HEADER) - creates it if necessary 99 * </p> 100 * 101 * 102 */ 103 public MSH getMSH() { 104 return getTyped("MSH", MSH.class); 105 } 106 107 108 109 110 111 /** 112 * <p> 113 * Returns 114 * MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary 115 * </p> 116 * 117 * 118 */ 119 public MSA getMSA() { 120 return getTyped("MSA", MSA.class); 121 } 122 123 124 125 126 127 /** 128 * <p> 129 * Returns 130 * the first repetition of 131 * NTE (NOTES AND COMMENTS) - creates it if necessary 132 * </p> 133 * 134 * 135 */ 136 public NTE getNTE() { 137 return getTyped("NTE", NTE.class); 138 } 139 140 141 /** 142 * <p> 143 * Returns a specific repetition of 144 * NTE (NOTES AND COMMENTS) - creates it if necessary 145 * </p> 146 * 147 * 148 * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0) 149 * @throws HL7Exception if the repetition requested is more than one 150 * greater than the number of existing repetitions. 151 */ 152 public NTE getNTE(int rep) { 153 return getTyped("NTE", rep, NTE.class); 154 } 155 156 /** 157 * <p> 158 * Returns the number of existing repetitions of NTE 159 * </p> 160 * 161 */ 162 public int getNTEReps() { 163 return getReps("NTE"); 164 } 165 166 /** 167 * <p> 168 * Returns a non-modifiable List containing all current existing repetitions of NTE. 169 * <p> 170 * <p> 171 * Note that unlike {@link #getNTE()}, this method will not create any reps 172 * if none are already present, so an empty list may be returned. 173 * </p> 174 * 175 */ 176 public java.util.List<NTE> getNTEAll() throws HL7Exception { 177 return getAllAsList("NTE", NTE.class); 178 } 179 180 /** 181 * <p> 182 * Inserts a specific repetition of NTE (NOTES AND COMMENTS) 183 * </p> 184 * 185 * 186 * @see AbstractGroup#insertRepetition(Structure, int) 187 */ 188 public void insertNTE(NTE structure, int rep) throws HL7Exception { 189 super.insertRepetition( "NTE", structure, rep); 190 } 191 192 193 /** 194 * <p> 195 * Inserts a specific repetition of NTE (NOTES AND COMMENTS) 196 * </p> 197 * 198 * 199 * @see AbstractGroup#insertRepetition(Structure, int) 200 */ 201 public NTE insertNTE(int rep) throws HL7Exception { 202 return (NTE)super.insertRepetition("NTE", rep); 203 } 204 205 206 /** 207 * <p> 208 * Removes a specific repetition of NTE (NOTES AND COMMENTS) 209 * </p> 210 * 211 * 212 * @see AbstractGroup#removeRepetition(String, int) 213 */ 214 public NTE removeNTE(int rep) throws HL7Exception { 215 return (NTE)super.removeRepetition("NTE", rep); 216 } 217 218 219 220 221 /** 222 * <p> 223 * Returns 224 * PATIENT (a Group object) - creates it if necessary 225 * </p> 226 * 227 * 228 */ 229 public ORR_O02_PATIENT getPATIENT() { 230 return getTyped("PATIENT", ORR_O02_PATIENT.class); 231 } 232 233 234 235 236 } 237