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.message;
35  
36  import ca.uhn.hl7v2.model.v25.group.*;
37  import ca.uhn.hl7v2.model.v25.segment.*;
38  
39  import ca.uhn.hl7v2.HL7Exception;
40  import ca.uhn.hl7v2.parser.ModelClassFactory;
41  import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
42  import ca.uhn.hl7v2.model.*;
43  
44  
45  /**
46   * <p>Represents a EAC_U07 message structure (see chapter 13.3.7). This structure contains the 
47   * following elements: </p>
48   * <ul>
49  		                 * <li>1: MSH (Message Header) <b> </b> </li>
50  		                 * <li>2: SFT (Software Segment) <b>optional repeating</b> </li>
51  		                 * <li>3: EQU (Equipment Detail) <b> </b> </li>
52  		                 * <li>4: EAC_U07_COMMAND (a Group object) <b> repeating</b> </li>
53  		                 * <li>5: ROL (Role) <b>optional </b> </li>
54   * </ul>
55   */
56  //@SuppressWarnings("unused")
57  public class EAC_U07 extends AbstractMessage  {
58  
59      /**
60       * Creates a new EAC_U07 message with DefaultModelClassFactory. 
61       */ 
62      public EAC_U07() { 
63         this(new DefaultModelClassFactory());
64      }
65  
66      /** 
67       * Creates a new EAC_U07 message with custom ModelClassFactory.
68       */
69      public EAC_U07(ModelClassFactory factory) {
70         super(factory);
71         init(factory);
72      }
73  
74      private void init(ModelClassFactory factory) {
75         try {
76                            this.add(MSH.class, true, false);
77  	                          this.add(SFT.class, false, true);
78  	                          this.add(EQU.class, true, false);
79  	                          this.add(EAC_U07_COMMAND.class, true, true);
80  	                          this.add(ROL.class, false, false);
81  	       } catch(HL7Exception e) {
82            log.error("Unexpected error creating EAC_U07 - this is probably a bug in the source code generator.", e);
83         }
84      }
85  
86  
87      /** 
88       * Returns "2.5"
89       */
90      public String getVersion() {
91         return "2.5";
92      }
93  
94  
95  
96  
97      /**
98       * <p>
99       * Returns
100      * MSH (Message Header) - creates it if necessary
101      * </p>
102      * 
103      *
104      */
105     public MSH getMSH() { 
106        return getTyped("MSH", MSH.class);
107     }
108 
109 
110 
111 
112 
113     /**
114      * <p>
115      * Returns
116      * the first repetition of 
117      * SFT (Software Segment) - creates it if necessary
118      * </p>
119      * 
120      *
121      */
122     public SFT getSFT() { 
123        return getTyped("SFT", SFT.class);
124     }
125 
126 
127     /**
128      * <p>
129      * Returns a specific repetition of
130      * SFT (Software Segment) - creates it if necessary
131      * </p>
132      * 
133      *
134      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
135      * @throws HL7Exception if the repetition requested is more than one 
136      *     greater than the number of existing repetitions.
137      */
138     public SFT getSFT(int rep) { 
139        return getTyped("SFT", rep, SFT.class);
140     }
141 
142     /** 
143      * <p>
144      * Returns the number of existing repetitions of SFT 
145      * </p>
146      * 
147      */ 
148     public int getSFTReps() { 
149     	return getReps("SFT");
150     } 
151 
152     /** 
153      * <p>
154      * Returns a non-modifiable List containing all current existing repetitions of SFT.
155      * <p>
156      * <p>
157      * Note that unlike {@link #getSFT()}, this method will not create any reps
158      * if none are already present, so an empty list may be returned.
159      * </p>
160      * 
161      */ 
162     public java.util.List<SFT> getSFTAll() throws HL7Exception {
163     	return getAllAsList("SFT", SFT.class);
164     } 
165 
166     /**
167      * <p>
168      * Inserts a specific repetition of SFT (Software Segment)
169      * </p>
170      * 
171      *
172      * @see AbstractGroup#insertRepetition(Structure, int) 
173      */
174     public void insertSFT(SFT structure, int rep) throws HL7Exception { 
175        super.insertRepetition( "SFT", structure, rep);
176     }
177 
178 
179     /**
180      * <p>
181      * Inserts a specific repetition of SFT (Software Segment)
182      * </p>
183      * 
184      *
185      * @see AbstractGroup#insertRepetition(Structure, int) 
186      */
187     public SFT insertSFT(int rep) throws HL7Exception { 
188        return (SFT)super.insertRepetition("SFT", rep);
189     }
190 
191 
192     /**
193      * <p>
194      * Removes a specific repetition of SFT (Software Segment)
195      * </p>
196      * 
197      *
198      * @see AbstractGroup#removeRepetition(String, int) 
199      */
200     public SFT removeSFT(int rep) throws HL7Exception { 
201        return (SFT)super.removeRepetition("SFT", rep);
202     }
203 
204 
205 
206 
207     /**
208      * <p>
209      * Returns
210      * EQU (Equipment Detail) - creates it if necessary
211      * </p>
212      * 
213      *
214      */
215     public EQU getEQU() { 
216        return getTyped("EQU", EQU.class);
217     }
218 
219 
220 
221 
222 
223     /**
224      * <p>
225      * Returns
226      * the first repetition of 
227      * COMMAND (a Group object) - creates it if necessary
228      * </p>
229      * 
230      *
231      */
232     public EAC_U07_COMMAND getCOMMAND() { 
233        return getTyped("COMMAND", EAC_U07_COMMAND.class);
234     }
235 
236 
237     /**
238      * <p>
239      * Returns a specific repetition of
240      * COMMAND (a Group object) - creates it if necessary
241      * </p>
242      * 
243      *
244      * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
245      * @throws HL7Exception if the repetition requested is more than one 
246      *     greater than the number of existing repetitions.
247      */
248     public EAC_U07_COMMAND getCOMMAND(int rep) { 
249        return getTyped("COMMAND", rep, EAC_U07_COMMAND.class);
250     }
251 
252     /** 
253      * <p>
254      * Returns the number of existing repetitions of COMMAND 
255      * </p>
256      * 
257      */ 
258     public int getCOMMANDReps() { 
259     	return getReps("COMMAND");
260     } 
261 
262     /** 
263      * <p>
264      * Returns a non-modifiable List containing all current existing repetitions of COMMAND.
265      * <p>
266      * <p>
267      * Note that unlike {@link #getCOMMAND()}, this method will not create any reps
268      * if none are already present, so an empty list may be returned.
269      * </p>
270      * 
271      */ 
272     public java.util.List<EAC_U07_COMMAND> getCOMMANDAll() throws HL7Exception {
273     	return getAllAsList("COMMAND", EAC_U07_COMMAND.class);
274     } 
275 
276     /**
277      * <p>
278      * Inserts a specific repetition of COMMAND (a Group object)
279      * </p>
280      * 
281      *
282      * @see AbstractGroup#insertRepetition(Structure, int) 
283      */
284     public void insertCOMMAND(EAC_U07_COMMAND structure, int rep) throws HL7Exception { 
285        super.insertRepetition( "COMMAND", structure, rep);
286     }
287 
288 
289     /**
290      * <p>
291      * Inserts a specific repetition of COMMAND (a Group object)
292      * </p>
293      * 
294      *
295      * @see AbstractGroup#insertRepetition(Structure, int) 
296      */
297     public EAC_U07_COMMAND insertCOMMAND(int rep) throws HL7Exception { 
298        return (EAC_U07_COMMAND)super.insertRepetition("COMMAND", rep);
299     }
300 
301 
302     /**
303      * <p>
304      * Removes a specific repetition of COMMAND (a Group object)
305      * </p>
306      * 
307      *
308      * @see AbstractGroup#removeRepetition(String, int) 
309      */
310     public EAC_U07_COMMAND removeCOMMAND(int rep) throws HL7Exception { 
311        return (EAC_U07_COMMAND)super.removeRepetition("COMMAND", rep);
312     }
313 
314 
315 
316 
317     /**
318      * <p>
319      * Returns
320      * ROL (Role) - creates it if necessary
321      * </p>
322      * 
323      *
324      */
325     public ROL getROL() { 
326        return getTyped("ROL", ROL.class);
327     }
328 
329 
330 
331 
332 }
333