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.v22.message;
035
036import ca.uhn.hl7v2.model.v22.group.*;
037import ca.uhn.hl7v2.model.v22.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 DSR_Q01 message structure (see chapter ?). 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: QRD (QUERY DEFINITION) <b> </b></li>
054                 * <li>5: QRF (QUERY FILTER) <b>optional </b></li>
055                 * <li>6: DSP (DISPLAY DATA) <b> repeating</b></li>
056                 * <li>7: DSC (CONTINUATION POINTER) <b>optional </b></li>
057 * </ul>
058 */
059@SuppressWarnings("unused")
060public class DSR_Q01 extends AbstractMessage  {
061
062    /**
063     * Creates a new DSR_Q01 message with DefaultModelClassFactory. 
064     */ 
065    public DSR_Q01() { 
066       this(new DefaultModelClassFactory());
067    }
068
069    /** 
070     * Creates a new DSR_Q01 message with custom ModelClassFactory.
071     */
072    public DSR_Q01(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(MSA.class, true, false);
081                          this.add(ERR.class, false, false);
082                          this.add(QRD.class, true, false);
083                          this.add(QRF.class, false, false);
084                          this.add(DSP.class, true, true);
085                          this.add(DSC.class, false, false);
086       } catch(HL7Exception e) {
087          log.error("Unexpected error creating DSR_Q01 - this is probably a bug in the source code generator.", e);
088       }
089    }
090
091    /** 
092     * Returns "2.2"
093     */
094    public String getVersion() {
095       return "2.2";
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     * MSA (MESSAGE ACKNOWLEDGMENT) - creates it if necessary
114     */
115    public MSA getMSA() { 
116       return getTyped("MSA", MSA.class);
117    }
118
119
120
121
122    /**
123     * Returns
124     * ERR (ERROR) - creates it if necessary
125     */
126    public ERR getERR() { 
127       return getTyped("ERR", ERR.class);
128    }
129
130
131
132
133    /**
134     * Returns
135     * QRD (QUERY DEFINITION) - creates it if necessary
136     */
137    public QRD getQRD() { 
138       return getTyped("QRD", QRD.class);
139    }
140
141
142
143
144    /**
145     * Returns
146     * QRF (QUERY FILTER) - creates it if necessary
147     */
148    public QRF getQRF() { 
149       return getTyped("QRF", QRF.class);
150    }
151
152
153
154
155    /**
156     * Returns
157     * the first repetition of 
158     * DSP (DISPLAY DATA) - creates it if necessary
159     */
160    public DSP getDSP() { 
161       return getTyped("DSP", DSP.class);
162    }
163
164
165    /**
166     * Returns a specific repetition of
167     * DSP (DISPLAY DATA) - creates it if necessary
168     *
169     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
170     * @throws HL7Exception if the repetition requested is more than one 
171     *     greater than the number of existing repetitions.
172     */
173    public DSP getDSP(int rep) { 
174       return getTyped("DSP", rep, DSP.class);
175    }
176
177    /** 
178     * Returns the number of existing repetitions of DSP 
179     */ 
180    public int getDSPReps() { 
181        return getReps("DSP");
182    } 
183
184    /** 
185     * <p>
186     * Returns a non-modifiable List containing all current existing repetitions of DSP.
187     * <p>
188     * <p>
189     * Note that unlike {@link #getDSP()}, this method will not create any reps
190     * if none are already present, so an empty list may be returned.
191     * </p>
192     */ 
193    public List<DSP> getDSPAll() throws HL7Exception {
194        return getAllAsList("DSP", DSP.class);
195    } 
196
197    /**
198     * Inserts a specific repetition of DSP (DISPLAY DATA)
199     * @see AbstractGroup#insertRepetition(Structure, int) 
200     */
201    public void insertDSP(DSP structure, int rep) throws HL7Exception { 
202       super.insertRepetition( "DSP", structure, rep);
203    }
204
205
206    /**
207     * Inserts a specific repetition of DSP (DISPLAY DATA)
208     * @see AbstractGroup#insertRepetition(Structure, int) 
209     */
210    public DSP insertDSP(int rep) throws HL7Exception { 
211       return (DSP)super.insertRepetition("DSP", rep);
212    }
213
214
215    /**
216     * Removes a specific repetition of DSP (DISPLAY DATA)
217     * @see AbstractGroup#removeRepetition(String, int) 
218     */
219    public DSP removeDSP(int rep) throws HL7Exception { 
220       return (DSP)super.removeRepetition("DSP", rep);
221    }
222
223
224
225    /**
226     * Returns
227     * DSC (CONTINUATION POINTER) - creates it if necessary
228     */
229    public DSC getDSC() { 
230       return getTyped("DSC", DSC.class);
231    }
232
233
234
235
236}
237