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.v26.segment;
035
036// import ca.uhn.hl7v2.model.v26.group.*;
037import ca.uhn.hl7v2.model.v26.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047/**
048 *<p>Represents an HL7 CM2 message segment (Clinical Study Schedule Master). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>CM2-1: Set ID- CM2 (SI) <b>optional </b>
052     * <li>CM2-2: Scheduled Time Point (CWE) <b> </b>
053     * <li>CM2-3: Description of Time Point (ST) <b>optional </b>
054     * <li>CM2-4: Events Scheduled This Time Point (CWE) <b> repeating</b>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class CM2 extends AbstractSegment {
059
060    /** 
061     * Creates a new CM2 segment
062     */
063    public CM2(Group parent, ModelClassFactory factory) {
064       super(parent, factory);
065       init(factory);
066    }
067
068    private void init(ModelClassFactory factory) {
069       try {
070                                  this.add(SI.class, false, 1, 4, new Object[]{ getMessage() }, "Set ID- CM2");
071                                  this.add(CWE.class, true, 1, 250, new Object[]{ getMessage() }, "Scheduled Time Point");
072                                  this.add(ST.class, false, 1, 300, new Object[]{ getMessage() }, "Description of Time Point");
073                                  this.add(CWE.class, true, 200, 250, new Object[]{ getMessage() }, "Events Scheduled This Time Point");
074       } catch(HL7Exception e) {
075          log.error("Unexpected error creating CM2 - this is probably a bug in the source code generator.", e);
076       }
077    }
078
079
080
081    /**
082     * Returns
083     * CM2-1: "Set ID- CM2" - creates it if necessary
084     */
085    public SI getSetIDCM2() { 
086                SI retVal = this.getTypedField(1, 0);
087                return retVal;
088    }
089    
090    /**
091     * Returns
092     * CM2-1: "Set ID- CM2" - creates it if necessary
093     */
094    public SI getCm21_SetIDCM2() { 
095                SI retVal = this.getTypedField(1, 0);
096                return retVal;
097    }
098
099
100
101    /**
102     * Returns
103     * CM2-2: "Scheduled Time Point" - creates it if necessary
104     */
105    public CWE getScheduledTimePoint() { 
106                CWE retVal = this.getTypedField(2, 0);
107                return retVal;
108    }
109    
110    /**
111     * Returns
112     * CM2-2: "Scheduled Time Point" - creates it if necessary
113     */
114    public CWE getCm22_ScheduledTimePoint() { 
115                CWE retVal = this.getTypedField(2, 0);
116                return retVal;
117    }
118
119
120
121    /**
122     * Returns
123     * CM2-3: "Description of Time Point" - creates it if necessary
124     */
125    public ST getDescriptionOfTimePoint() { 
126                ST retVal = this.getTypedField(3, 0);
127                return retVal;
128    }
129    
130    /**
131     * Returns
132     * CM2-3: "Description of Time Point" - creates it if necessary
133     */
134    public ST getCm23_DescriptionOfTimePoint() { 
135                ST retVal = this.getTypedField(3, 0);
136                return retVal;
137    }
138
139
140    /**
141     * Returns all repetitions of Events Scheduled This Time Point (CM2-4).
142     */
143    public CWE[] getEventsScheduledThisTimePoint() {
144        CWE[] retVal = this.getTypedField(4, new CWE[0]);
145        return retVal;
146    }
147
148
149    /**
150     * Returns all repetitions of Events Scheduled This Time Point (CM2-4).
151     */
152    public CWE[] getCm24_EventsScheduledThisTimePoint() {
153        CWE[] retVal = this.getTypedField(4, new CWE[0]);
154        return retVal;
155    }
156
157
158    /**
159     * Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
160     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
161     * it will return zero.
162     */
163    public int getEventsScheduledThisTimePointReps() {
164        return this.getReps(4);
165    }
166
167
168    /**
169     * Returns a specific repetition of
170     * CM2-4: "Events Scheduled This Time Point" - creates it if necessary
171     *
172     * @param rep The repetition index (0-indexed)
173     */
174    public CWE getEventsScheduledThisTimePoint(int rep) { 
175                CWE retVal = this.getTypedField(4, rep);
176                return retVal;
177    }
178
179    /**
180     * Returns a specific repetition of
181     * CM2-4: "Events Scheduled This Time Point" - creates it if necessary
182     *
183     * @param rep The repetition index (0-indexed)
184     */
185    public CWE getCm24_EventsScheduledThisTimePoint(int rep) { 
186                CWE retVal = this.getTypedField(4, rep);
187                return retVal;
188    }
189
190    /**
191     * Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
192     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
193     * it will return zero.
194     */
195    public int getCm24_EventsScheduledThisTimePointReps() {
196        return this.getReps(4);
197    }
198
199
200    /**
201     * Inserts a repetition of
202     * CM2-4: "Events Scheduled This Time Point" at a specific index
203     *
204     * @param rep The repetition index (0-indexed)
205     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
206     */
207    public CWE insertEventsScheduledThisTimePoint(int rep) throws HL7Exception { 
208        return (CWE) super.insertRepetition(4, rep);
209    }
210
211
212    /**
213     * Inserts a repetition of
214     * CM2-4: "Events Scheduled This Time Point" at a specific index
215     *
216     * @param rep The repetition index (0-indexed)
217     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
218     */
219    public CWE insertCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception { 
220        return (CWE) super.insertRepetition(4, rep);
221    }
222
223
224    /**
225     * Removes a repetition of
226     * CM2-4: "Events Scheduled This Time Point" at a specific index
227     *
228     * @param rep The repetition index (0-indexed)
229     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
230     */
231    public CWE removeEventsScheduledThisTimePoint(int rep) throws HL7Exception { 
232        return (CWE) super.removeRepetition(4, rep);
233    }
234
235
236    /**
237     * Removes a repetition of
238     * CM2-4: "Events Scheduled This Time Point" at a specific index
239     *
240     * @param rep The repetition index (0-indexed)
241     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
242     */
243    public CWE removeCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception { 
244        return (CWE) super.removeRepetition(4, rep);
245    }
246
247
248
249
250
251
252    /** {@inheritDoc} */   
253    protected Type createNewTypeWithoutReflection(int field) {
254       switch (field) {
255          case 0: return new SI(getMessage());
256          case 1: return new CWE(getMessage());
257          case 2: return new ST(getMessage());
258          case 3: return new CWE(getMessage());
259          default: return null;
260       }
261   }
262
263
264}
265