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.v251.segment;
35  
36  // import ca.uhn.hl7v2.model.v251.group.*;
37  import ca.uhn.hl7v2.model.v251.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 CSP message segment (Clinical Study Phase). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>CSP-1: Study Phase Identifier (CE) <b> </b>
53       * <li>CSP-2: Date/time Study Phase Began (TS) <b> </b>
54       * <li>CSP-3: Date/time Study Phase Ended (TS) <b>optional </b>
55       * <li>CSP-4: Study Phase Evaluability (CE) <b>optional </b>
56   * </ul>
57   */
58  @SuppressWarnings("unused")
59  public class CSP extends AbstractSegment {
60  
61      /** 
62       * Creates a new CSP segment
63       */
64      public CSP(Group parent, ModelClassFactory factory) {
65         super(parent, factory);
66         init(factory);
67      }
68  
69      private void init(ModelClassFactory factory) {
70         try {
71                                    this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "Study Phase Identifier");
72                                    this.add(TS.class, true, 1, 26, new Object[]{ getMessage() }, "Date/time Study Phase Began");
73                                    this.add(TS.class, false, 1, 26, new Object[]{ getMessage() }, "Date/time Study Phase Ended");
74                                    this.add(CE.class, false, 1, 250, new Object[]{ getMessage() }, "Study Phase Evaluability");
75         } catch(HL7Exception e) {
76            log.error("Unexpected error creating CSP - this is probably a bug in the source code generator.", e);
77         }
78      }
79  
80  
81  
82      /**
83       * Returns
84       * CSP-1: "Study Phase Identifier" - creates it if necessary
85       */
86      public CE getStudyPhaseIdentifier() { 
87  		CE retVal = this.getTypedField(1, 0);
88  		return retVal;
89      }
90      
91      /**
92       * Returns
93       * CSP-1: "Study Phase Identifier" - creates it if necessary
94       */
95      public CE getCsp1_StudyPhaseIdentifier() { 
96  		CE retVal = this.getTypedField(1, 0);
97  		return retVal;
98      }
99  
100 
101 
102     /**
103      * Returns
104      * CSP-2: "Date/time Study Phase Began" - creates it if necessary
105      */
106     public TS getDateTimeStudyPhaseBegan() { 
107 		TS retVal = this.getTypedField(2, 0);
108 		return retVal;
109     }
110     
111     /**
112      * Returns
113      * CSP-2: "Date/time Study Phase Began" - creates it if necessary
114      */
115     public TS getCsp2_DateTimeStudyPhaseBegan() { 
116 		TS retVal = this.getTypedField(2, 0);
117 		return retVal;
118     }
119 
120 
121 
122     /**
123      * Returns
124      * CSP-3: "Date/time Study Phase Ended" - creates it if necessary
125      */
126     public TS getDateTimeStudyPhaseEnded() { 
127 		TS retVal = this.getTypedField(3, 0);
128 		return retVal;
129     }
130     
131     /**
132      * Returns
133      * CSP-3: "Date/time Study Phase Ended" - creates it if necessary
134      */
135     public TS getCsp3_DateTimeStudyPhaseEnded() { 
136 		TS retVal = this.getTypedField(3, 0);
137 		return retVal;
138     }
139 
140 
141 
142     /**
143      * Returns
144      * CSP-4: "Study Phase Evaluability" - creates it if necessary
145      */
146     public CE getStudyPhaseEvaluability() { 
147 		CE retVal = this.getTypedField(4, 0);
148 		return retVal;
149     }
150     
151     /**
152      * Returns
153      * CSP-4: "Study Phase Evaluability" - creates it if necessary
154      */
155     public CE getCsp4_StudyPhaseEvaluability() { 
156 		CE retVal = this.getTypedField(4, 0);
157 		return retVal;
158     }
159 
160 
161 
162 
163 
164     /** {@inheritDoc} */   
165     protected Type createNewTypeWithoutReflection(int field) {
166        switch (field) {
167           case 0: return new CE(getMessage());
168           case 1: return new TS(getMessage());
169           case 2: return new TS(getMessage());
170           case 3: return new CE(getMessage());
171           default: return null;
172        }
173    }
174 
175 
176 }
177