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.message;
035
036import ca.uhn.hl7v2.model.v26.group.*;
037import ca.uhn.hl7v2.model.v26.segment.*;
038
039import java.util.List;
040
041import ca.uhn.hl7v2.HL7Exception;
042import ca.uhn.hl7v2.parser.ModelClassFactory;
043import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
044import ca.uhn.hl7v2.model.AbstractMessage;
045
046/**
047 * <p>Represents a PMU_B07 message structure (see chapter 15.3.8). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message Header) <b> </b></li>
051                 * <li>2: SFT (Software Segment) <b>optional repeating</b></li>
052                 * <li>3: UAC (User Authentication Credential Segment) <b>optional </b></li>
053                 * <li>4: EVN (Event Type) <b> </b></li>
054                 * <li>5: STF (Staff Identification) <b> </b></li>
055                 * <li>6: PRA (Practitioner Detail) <b>optional </b></li>
056                 * <li>7: PMU_B07_CERTIFICATE (a Group object) <b>optional repeating</b></li>
057 * </ul>
058 */
059@SuppressWarnings("unused")
060public class PMU_B07 extends AbstractMessage  {
061
062    /**
063     * Creates a new PMU_B07 message with DefaultModelClassFactory. 
064     */ 
065    public PMU_B07() { 
066       this(new DefaultModelClassFactory());
067    }
068
069    /** 
070     * Creates a new PMU_B07 message with custom ModelClassFactory.
071     */
072    public PMU_B07(ModelClassFactory factory) {
073       super(factory);
074       init(factory);
075    }
076
077    private void init(ModelClassFactory factory) {
078       try {
079                          this.add(MSH.class, true, false);
080                          this.add(SFT.class, false, true);
081                          this.add(UAC.class, false, false);
082                          this.add(EVN.class, true, false);
083                          this.add(STF.class, true, false);
084                          this.add(PRA.class, false, false);
085                          this.add(PMU_B07_CERTIFICATE.class, false, true);
086       } catch(HL7Exception e) {
087          log.error("Unexpected error creating PMU_B07 - this is probably a bug in the source code generator.", e);
088       }
089    }
090
091    /** 
092     * Returns "2.6"
093     */
094    public String getVersion() {
095       return "2.6";
096    }
097
098
099
100    /**
101     * Returns
102     * MSH (Message Header) - creates it if necessary
103     */
104    public MSH getMSH() { 
105       return getTyped("MSH", MSH.class);
106    }
107
108
109
110
111    /**
112     * Returns
113     * the first repetition of 
114     * SFT (Software Segment) - creates it if necessary
115     */
116    public SFT getSFT() { 
117       return getTyped("SFT", SFT.class);
118    }
119
120
121    /**
122     * Returns a specific repetition of
123     * SFT (Software Segment) - creates it if necessary
124     *
125     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
126     * @throws HL7Exception if the repetition requested is more than one 
127     *     greater than the number of existing repetitions.
128     */
129    public SFT getSFT(int rep) { 
130       return getTyped("SFT", rep, SFT.class);
131    }
132
133    /** 
134     * Returns the number of existing repetitions of SFT 
135     */ 
136    public int getSFTReps() { 
137        return getReps("SFT");
138    } 
139
140    /** 
141     * <p>
142     * Returns a non-modifiable List containing all current existing repetitions of SFT.
143     * <p>
144     * <p>
145     * Note that unlike {@link #getSFT()}, this method will not create any reps
146     * if none are already present, so an empty list may be returned.
147     * </p>
148     */ 
149    public List<SFT> getSFTAll() throws HL7Exception {
150        return getAllAsList("SFT", SFT.class);
151    } 
152
153    /**
154     * Inserts a specific repetition of SFT (Software Segment)
155     * @see AbstractGroup#insertRepetition(Structure, int) 
156     */
157    public void insertSFT(SFT structure, int rep) throws HL7Exception { 
158       super.insertRepetition( "SFT", structure, rep);
159    }
160
161
162    /**
163     * Inserts a specific repetition of SFT (Software Segment)
164     * @see AbstractGroup#insertRepetition(Structure, int) 
165     */
166    public SFT insertSFT(int rep) throws HL7Exception { 
167       return (SFT)super.insertRepetition("SFT", rep);
168    }
169
170
171    /**
172     * Removes a specific repetition of SFT (Software Segment)
173     * @see AbstractGroup#removeRepetition(String, int) 
174     */
175    public SFT removeSFT(int rep) throws HL7Exception { 
176       return (SFT)super.removeRepetition("SFT", rep);
177    }
178
179
180
181    /**
182     * Returns
183     * UAC (User Authentication Credential Segment) - creates it if necessary
184     */
185    public UAC getUAC() { 
186       return getTyped("UAC", UAC.class);
187    }
188
189
190
191
192    /**
193     * Returns
194     * EVN (Event Type) - creates it if necessary
195     */
196    public EVN getEVN() { 
197       return getTyped("EVN", EVN.class);
198    }
199
200
201
202
203    /**
204     * Returns
205     * STF (Staff Identification) - creates it if necessary
206     */
207    public STF getSTF() { 
208       return getTyped("STF", STF.class);
209    }
210
211
212
213
214    /**
215     * Returns
216     * PRA (Practitioner Detail) - creates it if necessary
217     */
218    public PRA getPRA() { 
219       return getTyped("PRA", PRA.class);
220    }
221
222
223
224
225    /**
226     * Returns
227     * the first repetition of 
228     * CERTIFICATE (a Group object) - creates it if necessary
229     */
230    public PMU_B07_CERTIFICATE getCERTIFICATE() { 
231       return getTyped("CERTIFICATE", PMU_B07_CERTIFICATE.class);
232    }
233
234
235    /**
236     * Returns a specific repetition of
237     * CERTIFICATE (a Group object) - creates it if necessary
238     *
239     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
240     * @throws HL7Exception if the repetition requested is more than one 
241     *     greater than the number of existing repetitions.
242     */
243    public PMU_B07_CERTIFICATE getCERTIFICATE(int rep) { 
244       return getTyped("CERTIFICATE", rep, PMU_B07_CERTIFICATE.class);
245    }
246
247    /** 
248     * Returns the number of existing repetitions of CERTIFICATE 
249     */ 
250    public int getCERTIFICATEReps() { 
251        return getReps("CERTIFICATE");
252    } 
253
254    /** 
255     * <p>
256     * Returns a non-modifiable List containing all current existing repetitions of CERTIFICATE.
257     * <p>
258     * <p>
259     * Note that unlike {@link #getCERTIFICATE()}, this method will not create any reps
260     * if none are already present, so an empty list may be returned.
261     * </p>
262     */ 
263    public List<PMU_B07_CERTIFICATE> getCERTIFICATEAll() throws HL7Exception {
264        return getAllAsList("CERTIFICATE", PMU_B07_CERTIFICATE.class);
265    } 
266
267    /**
268     * Inserts a specific repetition of CERTIFICATE (a Group object)
269     * @see AbstractGroup#insertRepetition(Structure, int) 
270     */
271    public void insertCERTIFICATE(PMU_B07_CERTIFICATE structure, int rep) throws HL7Exception { 
272       super.insertRepetition( "CERTIFICATE", structure, rep);
273    }
274
275
276    /**
277     * Inserts a specific repetition of CERTIFICATE (a Group object)
278     * @see AbstractGroup#insertRepetition(Structure, int) 
279     */
280    public PMU_B07_CERTIFICATE insertCERTIFICATE(int rep) throws HL7Exception { 
281       return (PMU_B07_CERTIFICATE)super.insertRepetition("CERTIFICATE", rep);
282    }
283
284
285    /**
286     * Removes a specific repetition of CERTIFICATE (a Group object)
287     * @see AbstractGroup#removeRepetition(String, int) 
288     */
289    public PMU_B07_CERTIFICATE removeCERTIFICATE(int rep) throws HL7Exception { 
290       return (PMU_B07_CERTIFICATE)super.removeRepetition("CERTIFICATE", rep);
291    }
292
293
294
295}
296