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.v24.message;
035
036import ca.uhn.hl7v2.model.v24.group.*;
037import ca.uhn.hl7v2.model.v24.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 PRR_PC5 message structure (see chapter 12). This structure contains the 
048 * following elements: </p>
049 * <ul>
050                 * <li>1: MSH (Message Header) <b> </b></li>
051                 * <li>2: MSA (Message Acknowledgment) <b> </b></li>
052                 * <li>3: ERR (Error) <b>optional </b></li>
053                 * <li>4: QAK (Query Acknowledgment) <b>optional </b></li>
054                 * <li>5: QRD (Original-Style Query Definition) <b> </b></li>
055                 * <li>6: PRR_PC5_PATIENT (a Group object) <b> repeating</b></li>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class PRR_PC5 extends AbstractMessage  {
060
061    /**
062     * Creates a new PRR_PC5 message with DefaultModelClassFactory. 
063     */ 
064    public PRR_PC5() { 
065       this(new DefaultModelClassFactory());
066    }
067
068    /** 
069     * Creates a new PRR_PC5 message with custom ModelClassFactory.
070     */
071    public PRR_PC5(ModelClassFactory factory) {
072       super(factory);
073       init(factory);
074    }
075
076    private void init(ModelClassFactory factory) {
077       try {
078                          this.add(MSH.class, true, false);
079                          this.add(MSA.class, true, false);
080                          this.add(ERR.class, false, false);
081                          this.add(QAK.class, false, false);
082                          this.add(QRD.class, true, false);
083                          this.add(PRR_PC5_PATIENT.class, true, true);
084       } catch(HL7Exception e) {
085          log.error("Unexpected error creating PRR_PC5 - this is probably a bug in the source code generator.", e);
086       }
087    }
088
089    /** 
090     * Returns "2.4"
091     */
092    public String getVersion() {
093       return "2.4";
094    }
095
096
097
098    /**
099     * Returns
100     * MSH (Message Header) - creates it if necessary
101     */
102    public MSH getMSH() { 
103       return getTyped("MSH", MSH.class);
104    }
105
106
107
108
109    /**
110     * Returns
111     * MSA (Message Acknowledgment) - creates it if necessary
112     */
113    public MSA getMSA() { 
114       return getTyped("MSA", MSA.class);
115    }
116
117
118
119
120    /**
121     * Returns
122     * ERR (Error) - creates it if necessary
123     */
124    public ERR getERR() { 
125       return getTyped("ERR", ERR.class);
126    }
127
128
129
130
131    /**
132     * Returns
133     * QAK (Query Acknowledgment) - creates it if necessary
134     */
135    public QAK getQAK() { 
136       return getTyped("QAK", QAK.class);
137    }
138
139
140
141
142    /**
143     * Returns
144     * QRD (Original-Style Query Definition) - creates it if necessary
145     */
146    public QRD getQRD() { 
147       return getTyped("QRD", QRD.class);
148    }
149
150
151
152
153    /**
154     * Returns
155     * the first repetition of 
156     * PATIENT (a Group object) - creates it if necessary
157     */
158    public PRR_PC5_PATIENT getPATIENT() { 
159       return getTyped("PATIENT", PRR_PC5_PATIENT.class);
160    }
161
162
163    /**
164     * Returns a specific repetition of
165     * PATIENT (a Group object) - creates it if necessary
166     *
167     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
168     * @throws HL7Exception if the repetition requested is more than one 
169     *     greater than the number of existing repetitions.
170     */
171    public PRR_PC5_PATIENT getPATIENT(int rep) { 
172       return getTyped("PATIENT", rep, PRR_PC5_PATIENT.class);
173    }
174
175    /** 
176     * Returns the number of existing repetitions of PATIENT 
177     */ 
178    public int getPATIENTReps() { 
179        return getReps("PATIENT");
180    } 
181
182    /** 
183     * <p>
184     * Returns a non-modifiable List containing all current existing repetitions of PATIENT.
185     * <p>
186     * <p>
187     * Note that unlike {@link #getPATIENT()}, this method will not create any reps
188     * if none are already present, so an empty list may be returned.
189     * </p>
190     */ 
191    public List<PRR_PC5_PATIENT> getPATIENTAll() throws HL7Exception {
192        return getAllAsList("PATIENT", PRR_PC5_PATIENT.class);
193    } 
194
195    /**
196     * Inserts a specific repetition of PATIENT (a Group object)
197     * @see AbstractGroup#insertRepetition(Structure, int) 
198     */
199    public void insertPATIENT(PRR_PC5_PATIENT structure, int rep) throws HL7Exception { 
200       super.insertRepetition( "PATIENT", structure, rep);
201    }
202
203
204    /**
205     * Inserts a specific repetition of PATIENT (a Group object)
206     * @see AbstractGroup#insertRepetition(Structure, int) 
207     */
208    public PRR_PC5_PATIENT insertPATIENT(int rep) throws HL7Exception { 
209       return (PRR_PC5_PATIENT)super.insertRepetition("PATIENT", rep);
210    }
211
212
213    /**
214     * Removes a specific repetition of PATIENT (a Group object)
215     * @see AbstractGroup#removeRepetition(String, int) 
216     */
217    public PRR_PC5_PATIENT removePATIENT(int rep) throws HL7Exception { 
218       return (PRR_PC5_PATIENT)super.removeRepetition("PATIENT", rep);
219    }
220
221
222
223}
224