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.v25.segment;
35  
36  // import ca.uhn.hl7v2.model.v25.group.*;
37  import ca.uhn.hl7v2.model.v25.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 LCC message segment (Location Charge Code). 
50   * This segment has the following fields:</p>
51   * <ul>
52       * <li>LCC-1: Primary Key Value - LCC (PL) <b> </b>
53       * <li>LCC-2: Location Department (CE) <b> </b>
54       * <li>LCC-3: Accommodation Type (CE) <b>optional repeating</b>
55       * <li>LCC-4: Charge Code (CE) <b> repeating</b>
56   * </ul>
57   */
58  @SuppressWarnings("unused")
59  public class LCC extends AbstractSegment {
60  
61      /** 
62       * Creates a new LCC segment
63       */
64      public LCC(Group parent, ModelClassFactory factory) {
65         super(parent, factory);
66         init(factory);
67      }
68  
69      private void init(ModelClassFactory factory) {
70         try {
71                                    this.add(PL.class, true, 1, 200, new Object[]{ getMessage() }, "Primary Key Value - LCC");
72                                    this.add(CE.class, true, 1, 250, new Object[]{ getMessage() }, "Location Department");
73                                    this.add(CE.class, false, 0, 250, new Object[]{ getMessage() }, "Accommodation Type");
74                                    this.add(CE.class, true, 0, 250, new Object[]{ getMessage() }, "Charge Code");
75         } catch(HL7Exception e) {
76            log.error("Unexpected error creating LCC - this is probably a bug in the source code generator.", e);
77         }
78      }
79  
80  
81  
82      /**
83       * Returns
84       * LCC-1: "Primary Key Value - LCC" - creates it if necessary
85       */
86      public PL getPrimaryKeyValueLCC() { 
87  		PL retVal = this.getTypedField(1, 0);
88  		return retVal;
89      }
90      
91      /**
92       * Returns
93       * LCC-1: "Primary Key Value - LCC" - creates it if necessary
94       */
95      public PL getLcc1_PrimaryKeyValueLCC() { 
96  		PL retVal = this.getTypedField(1, 0);
97  		return retVal;
98      }
99  
100 
101 
102     /**
103      * Returns
104      * LCC-2: "Location Department" - creates it if necessary
105      */
106     public CE getLocationDepartment() { 
107 		CE retVal = this.getTypedField(2, 0);
108 		return retVal;
109     }
110     
111     /**
112      * Returns
113      * LCC-2: "Location Department" - creates it if necessary
114      */
115     public CE getLcc2_LocationDepartment() { 
116 		CE retVal = this.getTypedField(2, 0);
117 		return retVal;
118     }
119 
120 
121     /**
122      * Returns all repetitions of Accommodation Type (LCC-3).
123      */
124     public CE[] getAccommodationType() {
125     	CE[] retVal = this.getTypedField(3, new CE[0]);
126     	return retVal;
127     }
128 
129 
130     /**
131      * Returns all repetitions of Accommodation Type (LCC-3).
132      */
133     public CE[] getLcc3_AccommodationType() {
134     	CE[] retVal = this.getTypedField(3, new CE[0]);
135     	return retVal;
136     }
137 
138 
139     /**
140      * Returns a count of the current number of repetitions of Accommodation Type (LCC-3).
141      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
142      * it will return zero.
143      */
144     public int getAccommodationTypeReps() {
145     	return this.getReps(3);
146     }
147 
148 
149     /**
150      * Returns a specific repetition of
151      * LCC-3: "Accommodation Type" - creates it if necessary
152      *
153      * @param rep The repetition index (0-indexed)
154      */
155     public CE getAccommodationType(int rep) { 
156 		CE retVal = this.getTypedField(3, rep);
157 		return retVal;
158     }
159 
160     /**
161      * Returns a specific repetition of
162      * LCC-3: "Accommodation Type" - creates it if necessary
163      *
164      * @param rep The repetition index (0-indexed)
165      */
166     public CE getLcc3_AccommodationType(int rep) { 
167 		CE retVal = this.getTypedField(3, rep);
168 		return retVal;
169     }
170 
171     /**
172      * Returns a count of the current number of repetitions of Accommodation Type (LCC-3).
173      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
174      * it will return zero.
175      */
176     public int getLcc3_AccommodationTypeReps() {
177     	return this.getReps(3);
178     }
179 
180 
181     /**
182      * Inserts a repetition of
183      * LCC-3: "Accommodation Type" at a specific index
184      *
185      * @param rep The repetition index (0-indexed)
186      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
187      */
188     public CE insertAccommodationType(int rep) throws HL7Exception { 
189         return (CE) super.insertRepetition(3, rep);
190     }
191 
192 
193     /**
194      * Inserts a repetition of
195      * LCC-3: "Accommodation Type" at a specific index
196      *
197      * @param rep The repetition index (0-indexed)
198      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
199      */
200     public CE insertLcc3_AccommodationType(int rep) throws HL7Exception { 
201         return (CE) super.insertRepetition(3, rep);
202     }
203 
204 
205     /**
206      * Removes a repetition of
207      * LCC-3: "Accommodation Type" at a specific index
208      *
209      * @param rep The repetition index (0-indexed)
210      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
211      */
212     public CE removeAccommodationType(int rep) throws HL7Exception { 
213         return (CE) super.removeRepetition(3, rep);
214     }
215 
216 
217     /**
218      * Removes a repetition of
219      * LCC-3: "Accommodation Type" at a specific index
220      *
221      * @param rep The repetition index (0-indexed)
222      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
223      */
224     public CE removeLcc3_AccommodationType(int rep) throws HL7Exception { 
225         return (CE) super.removeRepetition(3, rep);
226     }
227 
228 
229 
230     /**
231      * Returns all repetitions of Charge Code (LCC-4).
232      */
233     public CE[] getChargeCode() {
234     	CE[] retVal = this.getTypedField(4, new CE[0]);
235     	return retVal;
236     }
237 
238 
239     /**
240      * Returns all repetitions of Charge Code (LCC-4).
241      */
242     public CE[] getLcc4_ChargeCode() {
243     	CE[] retVal = this.getTypedField(4, new CE[0]);
244     	return retVal;
245     }
246 
247 
248     /**
249      * Returns a count of the current number of repetitions of Charge Code (LCC-4).
250      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
251      * it will return zero.
252      */
253     public int getChargeCodeReps() {
254     	return this.getReps(4);
255     }
256 
257 
258     /**
259      * Returns a specific repetition of
260      * LCC-4: "Charge Code" - creates it if necessary
261      *
262      * @param rep The repetition index (0-indexed)
263      */
264     public CE getChargeCode(int rep) { 
265 		CE retVal = this.getTypedField(4, rep);
266 		return retVal;
267     }
268 
269     /**
270      * Returns a specific repetition of
271      * LCC-4: "Charge Code" - creates it if necessary
272      *
273      * @param rep The repetition index (0-indexed)
274      */
275     public CE getLcc4_ChargeCode(int rep) { 
276 		CE retVal = this.getTypedField(4, rep);
277 		return retVal;
278     }
279 
280     /**
281      * Returns a count of the current number of repetitions of Charge Code (LCC-4).
282      * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
283      * it will return zero.
284      */
285     public int getLcc4_ChargeCodeReps() {
286     	return this.getReps(4);
287     }
288 
289 
290     /**
291      * Inserts a repetition of
292      * LCC-4: "Charge Code" at a specific index
293      *
294      * @param rep The repetition index (0-indexed)
295      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
296      */
297     public CE insertChargeCode(int rep) throws HL7Exception { 
298         return (CE) super.insertRepetition(4, rep);
299     }
300 
301 
302     /**
303      * Inserts a repetition of
304      * LCC-4: "Charge Code" at a specific index
305      *
306      * @param rep The repetition index (0-indexed)
307      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
308      */
309     public CE insertLcc4_ChargeCode(int rep) throws HL7Exception { 
310         return (CE) super.insertRepetition(4, rep);
311     }
312 
313 
314     /**
315      * Removes a repetition of
316      * LCC-4: "Charge Code" at a specific index
317      *
318      * @param rep The repetition index (0-indexed)
319      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
320      */
321     public CE removeChargeCode(int rep) throws HL7Exception { 
322         return (CE) super.removeRepetition(4, rep);
323     }
324 
325 
326     /**
327      * Removes a repetition of
328      * LCC-4: "Charge Code" at a specific index
329      *
330      * @param rep The repetition index (0-indexed)
331      * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
332      */
333     public CE removeLcc4_ChargeCode(int rep) throws HL7Exception { 
334         return (CE) super.removeRepetition(4, rep);
335     }
336 
337 
338 
339 
340 
341 
342     /** {@inheritDoc} */   
343     protected Type createNewTypeWithoutReflection(int field) {
344        switch (field) {
345           case 0: return new PL(getMessage());
346           case 1: return new CE(getMessage());
347           case 2: return new CE(getMessage());
348           case 3: return new CE(getMessage());
349           default: return null;
350        }
351    }
352 
353 
354 }
355