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.v25.message;
035
036import ca.uhn.hl7v2.model.v25.group.*;
037import ca.uhn.hl7v2.model.v25.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 PPP_PCB message structure (see chapter 12.3.3). 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: PID (Patient Identification) <b> </b></li>
053                 * <li>4: PPP_PCB_PATIENT_VISIT (a Group object) <b>optional </b></li>
054                 * <li>5: PPP_PCB_PATHWAY (a Group object) <b> repeating</b></li>
055 * </ul>
056 */
057@SuppressWarnings("unused")
058public class PPP_PCB extends AbstractMessage  {
059
060    /**
061     * Creates a new PPP_PCB message with DefaultModelClassFactory. 
062     */ 
063    public PPP_PCB() { 
064       this(new DefaultModelClassFactory());
065    }
066
067    /** 
068     * Creates a new PPP_PCB message with custom ModelClassFactory.
069     */
070    public PPP_PCB(ModelClassFactory factory) {
071       super(factory);
072       init(factory);
073    }
074
075    private void init(ModelClassFactory factory) {
076       try {
077                          this.add(MSH.class, true, false);
078                          this.add(SFT.class, false, true);
079                          this.add(PID.class, true, false);
080                          this.add(PPP_PCB_PATIENT_VISIT.class, false, false);
081                          this.add(PPP_PCB_PATHWAY.class, true, true);
082       } catch(HL7Exception e) {
083          log.error("Unexpected error creating PPP_PCB - this is probably a bug in the source code generator.", e);
084       }
085    }
086
087    /** 
088     * Returns "2.5"
089     */
090    public String getVersion() {
091       return "2.5";
092    }
093
094
095
096    /**
097     * Returns
098     * MSH (Message Header) - creates it if necessary
099     */
100    public MSH getMSH() { 
101       return getTyped("MSH", MSH.class);
102    }
103
104
105
106
107    /**
108     * Returns
109     * the first repetition of 
110     * SFT (Software Segment) - creates it if necessary
111     */
112    public SFT getSFT() { 
113       return getTyped("SFT", SFT.class);
114    }
115
116
117    /**
118     * Returns a specific repetition of
119     * SFT (Software Segment) - creates it if necessary
120     *
121     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
122     * @throws HL7Exception if the repetition requested is more than one 
123     *     greater than the number of existing repetitions.
124     */
125    public SFT getSFT(int rep) { 
126       return getTyped("SFT", rep, SFT.class);
127    }
128
129    /** 
130     * Returns the number of existing repetitions of SFT 
131     */ 
132    public int getSFTReps() { 
133        return getReps("SFT");
134    } 
135
136    /** 
137     * <p>
138     * Returns a non-modifiable List containing all current existing repetitions of SFT.
139     * <p>
140     * <p>
141     * Note that unlike {@link #getSFT()}, this method will not create any reps
142     * if none are already present, so an empty list may be returned.
143     * </p>
144     */ 
145    public List<SFT> getSFTAll() throws HL7Exception {
146        return getAllAsList("SFT", SFT.class);
147    } 
148
149    /**
150     * Inserts a specific repetition of SFT (Software Segment)
151     * @see AbstractGroup#insertRepetition(Structure, int) 
152     */
153    public void insertSFT(SFT structure, int rep) throws HL7Exception { 
154       super.insertRepetition( "SFT", structure, rep);
155    }
156
157
158    /**
159     * Inserts a specific repetition of SFT (Software Segment)
160     * @see AbstractGroup#insertRepetition(Structure, int) 
161     */
162    public SFT insertSFT(int rep) throws HL7Exception { 
163       return (SFT)super.insertRepetition("SFT", rep);
164    }
165
166
167    /**
168     * Removes a specific repetition of SFT (Software Segment)
169     * @see AbstractGroup#removeRepetition(String, int) 
170     */
171    public SFT removeSFT(int rep) throws HL7Exception { 
172       return (SFT)super.removeRepetition("SFT", rep);
173    }
174
175
176
177    /**
178     * Returns
179     * PID (Patient Identification) - creates it if necessary
180     */
181    public PID getPID() { 
182       return getTyped("PID", PID.class);
183    }
184
185
186
187
188    /**
189     * Returns
190     * PATIENT_VISIT (a Group object) - creates it if necessary
191     */
192    public PPP_PCB_PATIENT_VISIT getPATIENT_VISIT() { 
193       return getTyped("PATIENT_VISIT", PPP_PCB_PATIENT_VISIT.class);
194    }
195
196
197
198
199    /**
200     * Returns
201     * the first repetition of 
202     * PATHWAY (a Group object) - creates it if necessary
203     */
204    public PPP_PCB_PATHWAY getPATHWAY() { 
205       return getTyped("PATHWAY", PPP_PCB_PATHWAY.class);
206    }
207
208
209    /**
210     * Returns a specific repetition of
211     * PATHWAY (a Group object) - creates it if necessary
212     *
213     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
214     * @throws HL7Exception if the repetition requested is more than one 
215     *     greater than the number of existing repetitions.
216     */
217    public PPP_PCB_PATHWAY getPATHWAY(int rep) { 
218       return getTyped("PATHWAY", rep, PPP_PCB_PATHWAY.class);
219    }
220
221    /** 
222     * Returns the number of existing repetitions of PATHWAY 
223     */ 
224    public int getPATHWAYReps() { 
225        return getReps("PATHWAY");
226    } 
227
228    /** 
229     * <p>
230     * Returns a non-modifiable List containing all current existing repetitions of PATHWAY.
231     * <p>
232     * <p>
233     * Note that unlike {@link #getPATHWAY()}, this method will not create any reps
234     * if none are already present, so an empty list may be returned.
235     * </p>
236     */ 
237    public List<PPP_PCB_PATHWAY> getPATHWAYAll() throws HL7Exception {
238        return getAllAsList("PATHWAY", PPP_PCB_PATHWAY.class);
239    } 
240
241    /**
242     * Inserts a specific repetition of PATHWAY (a Group object)
243     * @see AbstractGroup#insertRepetition(Structure, int) 
244     */
245    public void insertPATHWAY(PPP_PCB_PATHWAY structure, int rep) throws HL7Exception { 
246       super.insertRepetition( "PATHWAY", structure, rep);
247    }
248
249
250    /**
251     * Inserts a specific repetition of PATHWAY (a Group object)
252     * @see AbstractGroup#insertRepetition(Structure, int) 
253     */
254    public PPP_PCB_PATHWAY insertPATHWAY(int rep) throws HL7Exception { 
255       return (PPP_PCB_PATHWAY)super.insertRepetition("PATHWAY", rep);
256    }
257
258
259    /**
260     * Removes a specific repetition of PATHWAY (a Group object)
261     * @see AbstractGroup#removeRepetition(String, int) 
262     */
263    public PPP_PCB_PATHWAY removePATHWAY(int rep) throws HL7Exception { 
264       return (PPP_PCB_PATHWAY)super.removeRepetition("PATHWAY", rep);
265    }
266
267
268
269}
270