View Javadoc
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.v281.segment;
35  
36  // import ca.uhn.hl7v2.model.v281.group.*;
37  import ca.uhn.hl7v2.model.v281.datatype.*;
38  import ca.uhn.hl7v2.HL7Exception;
39  import ca.uhn.hl7v2.parser.ModelClassFactory;
40  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
41  import ca.uhn.hl7v2.model.AbstractMessage;
42  import ca.uhn.hl7v2.model.Group;
43  import ca.uhn.hl7v2.model.Type;
44  import ca.uhn.hl7v2.model.AbstractSegment;
45  import ca.uhn.hl7v2.model.Varies;
46  
47  
48  /**
49   *<p>Represents an HL7 CM2 message segment (Clinical Study Schedule Master). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>CM2-1: Set ID- CM2 (SI) <b>optional </b>
53       * <li>CM2-2: Scheduled Time Point (CWE) <b> </b>
54       * <li>CM2-3: Description of Time Point (ST) <b>optional </b>
55       * <li>CM2-4: Events Scheduled This Time Point (CWE) <b> repeating</b>
56   * </ul>
57   */
58  @SuppressWarnings("unused")
59  public class CM2 extends AbstractSegment {
60  
61      /** 
62       * Creates a new CM2 segment
63       */
64      public CM2(Group parent, ModelClassFactory factory) {
65         super(parent, factory);
66         init(factory);
67      }
68  
69      private void init(ModelClassFactory factory) {
70         try {
71                                    this.add(SI.class, false, 1, 0, new Object[]{ getMessage() }, "Set ID- CM2");
72                                    this.add(CWE.class, true, 1, 0, new Object[]{ getMessage() }, "Scheduled Time Point");
73                                    this.add(ST.class, false, 1, 0, new Object[]{ getMessage() }, "Description of Time Point");
74                                    this.add(CWE.class, true, 200, 0, new Object[]{ getMessage() }, "Events Scheduled This Time Point");
75         } catch(HL7Exception e) {
76            log.error("Unexpected error creating CM2 - this is probably a bug in the source code generator.", e);
77         }
78      }
79  
80  
81  
82      /**
83       * Returns
84       * CM2-1: "Set ID- CM2" - creates it if necessary
85       */
86      public SI getSetIDCM2() { 
87  		SI retVal = this.getTypedField(1, 0);
88  		return retVal;
89      }
90      
91      /**
92       * Returns
93       * CM2-1: "Set ID- CM2" - creates it if necessary
94       */
95      public SI getCm21_SetIDCM2() { 
96  		SI retVal = this.getTypedField(1, 0);
97  		return retVal;
98      }
99  
100 
101 
102     /**
103      * Returns
104      * CM2-2: "Scheduled Time Point" - creates it if necessary
105      */
106     public CWE getScheduledTimePoint() { 
107 		CWE retVal = this.getTypedField(2, 0);
108 		return retVal;
109     }
110     
111     /**
112      * Returns
113      * CM2-2: "Scheduled Time Point" - creates it if necessary
114      */
115     public CWE getCm22_ScheduledTimePoint() { 
116 		CWE retVal = this.getTypedField(2, 0);
117 		return retVal;
118     }
119 
120 
121 
122     /**
123      * Returns
124      * CM2-3: "Description of Time Point" - creates it if necessary
125      */
126     public ST getDescriptionOfTimePoint() { 
127 		ST retVal = this.getTypedField(3, 0);
128 		return retVal;
129     }
130     
131     /**
132      * Returns
133      * CM2-3: "Description of Time Point" - creates it if necessary
134      */
135     public ST getCm23_DescriptionOfTimePoint() { 
136 		ST retVal = this.getTypedField(3, 0);
137 		return retVal;
138     }
139 
140 
141     /**
142      * Returns all repetitions of Events Scheduled This Time Point (CM2-4).
143      */
144     public CWE[] getEventsScheduledThisTimePoint() {
145     	CWE[] retVal = this.getTypedField(4, new CWE[0]);
146     	return retVal;
147     }
148 
149 
150     /**
151      * Returns all repetitions of Events Scheduled This Time Point (CM2-4).
152      */
153     public CWE[] getCm24_EventsScheduledThisTimePoint() {
154     	CWE[] retVal = this.getTypedField(4, new CWE[0]);
155     	return retVal;
156     }
157 
158 
159     /**
160      * Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
161      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
162      * it will return zero.
163      */
164     public int getEventsScheduledThisTimePointReps() {
165     	return this.getReps(4);
166     }
167 
168 
169     /**
170      * Returns a specific repetition of
171      * CM2-4: "Events Scheduled This Time Point" - creates it if necessary
172      *
173      * @param rep The repetition index (0-indexed)
174      */
175     public CWE getEventsScheduledThisTimePoint(int rep) { 
176 		CWE retVal = this.getTypedField(4, rep);
177 		return retVal;
178     }
179 
180     /**
181      * Returns a specific repetition of
182      * CM2-4: "Events Scheduled This Time Point" - creates it if necessary
183      *
184      * @param rep The repetition index (0-indexed)
185      */
186     public CWE getCm24_EventsScheduledThisTimePoint(int rep) { 
187 		CWE retVal = this.getTypedField(4, rep);
188 		return retVal;
189     }
190 
191     /**
192      * Returns a count of the current number of repetitions of Events Scheduled This Time Point (CM2-4).
193      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
194      * it will return zero.
195      */
196     public int getCm24_EventsScheduledThisTimePointReps() {
197     	return this.getReps(4);
198     }
199 
200 
201     /**
202      * Inserts a repetition of
203      * CM2-4: "Events Scheduled This Time Point" at a specific index
204      *
205      * @param rep The repetition index (0-indexed)
206      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
207      */
208     public CWE insertEventsScheduledThisTimePoint(int rep) throws HL7Exception { 
209         return (CWE) super.insertRepetition(4, rep);
210     }
211 
212 
213     /**
214      * Inserts a repetition of
215      * CM2-4: "Events Scheduled This Time Point" at a specific index
216      *
217      * @param rep The repetition index (0-indexed)
218      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
219      */
220     public CWE insertCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception { 
221         return (CWE) super.insertRepetition(4, rep);
222     }
223 
224 
225     /**
226      * Removes a repetition of
227      * CM2-4: "Events Scheduled This Time Point" at a specific index
228      *
229      * @param rep The repetition index (0-indexed)
230      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
231      */
232     public CWE removeEventsScheduledThisTimePoint(int rep) throws HL7Exception { 
233         return (CWE) super.removeRepetition(4, rep);
234     }
235 
236 
237     /**
238      * Removes a repetition of
239      * CM2-4: "Events Scheduled This Time Point" at a specific index
240      *
241      * @param rep The repetition index (0-indexed)
242      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
243      */
244     public CWE removeCm24_EventsScheduledThisTimePoint(int rep) throws HL7Exception { 
245         return (CWE) super.removeRepetition(4, rep);
246     }
247 
248 
249 
250 
251 
252 
253     /** {@inheritDoc} */   
254     protected Type createNewTypeWithoutReflection(int field) {
255        switch (field) {
256           case 0: return new SI(getMessage());
257           case 1: return new CWE(getMessage());
258           case 2: return new ST(getMessage());
259           case 3: return new CWE(getMessage());
260           default: return null;
261        }
262    }
263 
264 
265 }
266