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 ca.uhn.hl7v2.HL7Exception;
040import ca.uhn.hl7v2.parser.ModelClassFactory;
041import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
042import ca.uhn.hl7v2.model.*;
043
044
045/**
046 * <p>Represents a UDM_Q05 message structure (see chapter ?). This structure contains the 
047 * following elements: </p>
048 * <ul>
049                                 * <li>1: MSH (MESSAGE HEADER) <b> </b> </li>
050                                 * <li>2: URD (RESULTS/UPDATE DEFINITION) <b> </b> </li>
051                                 * <li>3: URS (UNSOLICITED SELECTION) <b>optional </b> </li>
052                                 * <li>4: DSP (DISPLAY DATA) <b> repeating</b> </li>
053                                 * <li>5: DSC (CONTINUATION POINTER) <b> </b> </li>
054 * </ul>
055 */
056//@SuppressWarnings("unused")
057public class UDM_Q05 extends AbstractMessage  {
058
059    /**
060     * Creates a new UDM_Q05 message with DefaultModelClassFactory. 
061     */ 
062    public UDM_Q05() { 
063       this(new DefaultModelClassFactory());
064    }
065
066    /** 
067     * Creates a new UDM_Q05 message with custom ModelClassFactory.
068     */
069    public UDM_Q05(ModelClassFactory factory) {
070       super(factory);
071       init(factory);
072    }
073
074    private void init(ModelClassFactory factory) {
075       try {
076                          this.add(MSH.class, true, false);
077                                  this.add(URD.class, true, false);
078                                  this.add(URS.class, false, false);
079                                  this.add(DSP.class, true, true);
080                                  this.add(DSC.class, true, false);
081               } catch(HL7Exception e) {
082          log.error("Unexpected error creating UDM_Q05 - this is probably a bug in the source code generator.", e);
083       }
084    }
085
086
087    /** 
088     * Returns "2.2"
089     */
090    public String getVersion() {
091       return "2.2";
092    }
093
094
095
096
097    /**
098     * <p>
099     * 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     * URD (RESULTS/UPDATE DEFINITION) - creates it if necessary
117     * </p>
118     * 
119     *
120     */
121    public URD getURD() { 
122       return getTyped("URD", URD.class);
123    }
124
125
126
127
128
129    /**
130     * <p>
131     * Returns
132     * URS (UNSOLICITED SELECTION) - creates it if necessary
133     * </p>
134     * 
135     *
136     */
137    public URS getURS() { 
138       return getTyped("URS", URS.class);
139    }
140
141
142
143
144
145    /**
146     * <p>
147     * Returns
148     * the first repetition of 
149     * DSP (DISPLAY DATA) - creates it if necessary
150     * </p>
151     * 
152     *
153     */
154    public DSP getDSP() { 
155       return getTyped("DSP", DSP.class);
156    }
157
158
159    /**
160     * <p>
161     * Returns a specific repetition of
162     * DSP (DISPLAY DATA) - creates it if necessary
163     * </p>
164     * 
165     *
166     * @param rep The repetition index (0-indexed, i.e. the first repetition is at index 0)
167     * @throws HL7Exception if the repetition requested is more than one 
168     *     greater than the number of existing repetitions.
169     */
170    public DSP getDSP(int rep) { 
171       return getTyped("DSP", rep, DSP.class);
172    }
173
174    /** 
175     * <p>
176     * Returns the number of existing repetitions of DSP 
177     * </p>
178     * 
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     */ 
194    public java.util.List<DSP> getDSPAll() throws HL7Exception {
195        return getAllAsList("DSP", DSP.class);
196    } 
197
198    /**
199     * <p>
200     * Inserts a specific repetition of DSP (DISPLAY DATA)
201     * </p>
202     * 
203     *
204     * @see AbstractGroup#insertRepetition(Structure, int) 
205     */
206    public void insertDSP(DSP structure, int rep) throws HL7Exception { 
207       super.insertRepetition( "DSP", structure, rep);
208    }
209
210
211    /**
212     * <p>
213     * Inserts a specific repetition of DSP (DISPLAY DATA)
214     * </p>
215     * 
216     *
217     * @see AbstractGroup#insertRepetition(Structure, int) 
218     */
219    public DSP insertDSP(int rep) throws HL7Exception { 
220       return (DSP)super.insertRepetition("DSP", rep);
221    }
222
223
224    /**
225     * <p>
226     * Removes a specific repetition of DSP (DISPLAY DATA)
227     * </p>
228     * 
229     *
230     * @see AbstractGroup#removeRepetition(String, int) 
231     */
232    public DSP removeDSP(int rep) throws HL7Exception { 
233       return (DSP)super.removeRepetition("DSP", rep);
234    }
235
236
237
238
239    /**
240     * <p>
241     * Returns
242     * DSC (CONTINUATION POINTER) - creates it if necessary
243     * </p>
244     * 
245     *
246     */
247    public DSC getDSC() { 
248       return getTyped("DSC", DSC.class);
249    }
250
251
252
253
254}
255