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