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