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.segment;
035
036// import ca.uhn.hl7v2.model.v22.group.*;
037import ca.uhn.hl7v2.model.v22.datatype.*;
038import ca.uhn.hl7v2.HL7Exception;
039import ca.uhn.hl7v2.parser.ModelClassFactory;
040import ca.uhn.hl7v2.parser.DefaultModelClassFactory;
041import ca.uhn.hl7v2.model.AbstractMessage;
042import ca.uhn.hl7v2.model.Group;
043import ca.uhn.hl7v2.model.Type;
044import ca.uhn.hl7v2.model.AbstractSegment;
045import ca.uhn.hl7v2.model.Varies;
046
047/**
048 *<p>Represents an HL7 NTE message segment (NOTES AND COMMENTS). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>NTE-1: Set ID - Notes and Comments (SI) <b>optional </b>
052     * <li>NTE-2: Source of Comment (ID) <b>optional </b>
053     * <li>NTE-3: Comment (FT) <b>optional repeating</b>
054 * </ul>
055 */
056@SuppressWarnings("unused")
057public class NTE extends AbstractSegment {
058
059    /** 
060     * Creates a new NTE segment
061     */
062    public NTE(Group parent, ModelClassFactory factory) {
063       super(parent, factory);
064       init(factory);
065    }
066
067    private void init(ModelClassFactory factory) {
068       try {
069                                  this.add(SI.class, false, 1, 4, new Object[]{ getMessage() }, "Set ID - Notes and Comments");
070                                              this.add(ID.class, false, 1, 8, new Object[]{ getMessage(), new Integer(105) }, "Source of Comment");
071                                  this.add(FT.class, false, 0, 65536, new Object[]{ getMessage() }, "Comment");
072       } catch(HL7Exception e) {
073          log.error("Unexpected error creating NTE - this is probably a bug in the source code generator.", e);
074       }
075    }
076
077
078
079    /**
080     * Returns
081     * NTE-1: "Set ID - Notes and Comments" - creates it if necessary
082     */
083    public SI getSetIDNotesAndComments() { 
084                SI retVal = this.getTypedField(1, 0);
085                return retVal;
086    }
087    
088    /**
089     * Returns
090     * NTE-1: "Set ID - Notes and Comments" - creates it if necessary
091     */
092    public SI getNte1_SetIDNotesAndComments() { 
093                SI retVal = this.getTypedField(1, 0);
094                return retVal;
095    }
096
097
098
099    /**
100     * Returns
101     * NTE-2: "Source of Comment" - creates it if necessary
102     */
103    public ID getSourceOfComment() { 
104                ID retVal = this.getTypedField(2, 0);
105                return retVal;
106    }
107    
108    /**
109     * Returns
110     * NTE-2: "Source of Comment" - creates it if necessary
111     */
112    public ID getNte2_SourceOfComment() { 
113                ID retVal = this.getTypedField(2, 0);
114                return retVal;
115    }
116
117
118    /**
119     * Returns all repetitions of Comment (NTE-3).
120     */
121    public FT[] getComment() {
122        FT[] retVal = this.getTypedField(3, new FT[0]);
123        return retVal;
124    }
125
126
127    /**
128     * Returns all repetitions of Comment (NTE-3).
129     */
130    public FT[] getNte3_Comment() {
131        FT[] retVal = this.getTypedField(3, new FT[0]);
132        return retVal;
133    }
134
135
136    /**
137     * Returns a count of the current number of repetitions of Comment (NTE-3).
138     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
139     * it will return zero.
140     */
141    public int getCommentReps() {
142        return this.getReps(3);
143    }
144
145
146    /**
147     * Returns a specific repetition of
148     * NTE-3: "Comment" - creates it if necessary
149     *
150     * @param rep The repetition index (0-indexed)
151     */
152    public FT getComment(int rep) { 
153                FT retVal = this.getTypedField(3, rep);
154                return retVal;
155    }
156
157    /**
158     * Returns a specific repetition of
159     * NTE-3: "Comment" - creates it if necessary
160     *
161     * @param rep The repetition index (0-indexed)
162     */
163    public FT getNte3_Comment(int rep) { 
164                FT retVal = this.getTypedField(3, rep);
165                return retVal;
166    }
167
168    /**
169     * Returns a count of the current number of repetitions of Comment (NTE-3).
170     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
171     * it will return zero.
172     */
173    public int getNte3_CommentReps() {
174        return this.getReps(3);
175    }
176
177
178    /**
179     * Inserts a repetition of
180     * NTE-3: "Comment" at a specific index
181     *
182     * @param rep The repetition index (0-indexed)
183     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
184     */
185    public FT insertComment(int rep) throws HL7Exception { 
186        return (FT) super.insertRepetition(3, rep);
187    }
188
189
190    /**
191     * Inserts a repetition of
192     * NTE-3: "Comment" at a specific index
193     *
194     * @param rep The repetition index (0-indexed)
195     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
196     */
197    public FT insertNte3_Comment(int rep) throws HL7Exception { 
198        return (FT) super.insertRepetition(3, rep);
199    }
200
201
202    /**
203     * Removes a repetition of
204     * NTE-3: "Comment" at a specific index
205     *
206     * @param rep The repetition index (0-indexed)
207     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
208     */
209    public FT removeComment(int rep) throws HL7Exception { 
210        return (FT) super.removeRepetition(3, rep);
211    }
212
213
214    /**
215     * Removes a repetition of
216     * NTE-3: "Comment" at a specific index
217     *
218     * @param rep The repetition index (0-indexed)
219     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
220     */
221    public FT removeNte3_Comment(int rep) throws HL7Exception { 
222        return (FT) super.removeRepetition(3, rep);
223    }
224
225
226
227
228
229
230    /** {@inheritDoc} */   
231    protected Type createNewTypeWithoutReflection(int field) {
232       switch (field) {
233          case 0: return new SI(getMessage());
234          case 1: return new ID(getMessage(), new Integer( 105 ));
235          case 2: return new FT(getMessage());
236          default: return null;
237       }
238   }
239
240
241}
242