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.v26.segment;
035
036// import ca.uhn.hl7v2.model.v26.group.*;
037import ca.uhn.hl7v2.model.v26.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 AFF message segment (Professional Affiliation). 
049 * This segment has the following fields:</p>
050 * <ul>
051     * <li>AFF-1: Set ID - AFF (SI) <b> </b>
052     * <li>AFF-2: Professional Organization (XON) <b> </b>
053     * <li>AFF-3: Professional Organization Address (XAD) <b>optional </b>
054     * <li>AFF-4: Professional Organization Affiliation Date Range (DR) <b>optional repeating</b>
055     * <li>AFF-5: Professional Affiliation Additional Information (ST) <b>optional </b>
056 * </ul>
057 */
058@SuppressWarnings("unused")
059public class AFF extends AbstractSegment {
060
061    /** 
062     * Creates a new AFF segment
063     */
064    public AFF(Group parent, ModelClassFactory factory) {
065       super(parent, factory);
066       init(factory);
067    }
068
069    private void init(ModelClassFactory factory) {
070       try {
071                                  this.add(SI.class, true, 1, 60, new Object[]{ getMessage() }, "Set ID - AFF");
072                                  this.add(XON.class, true, 1, 250, new Object[]{ getMessage() }, "Professional Organization");
073                                  this.add(XAD.class, false, 1, 250, new Object[]{ getMessage() }, "Professional Organization Address");
074                                  this.add(DR.class, false, 0, 52, new Object[]{ getMessage() }, "Professional Organization Affiliation Date Range");
075                                  this.add(ST.class, false, 1, 60, new Object[]{ getMessage() }, "Professional Affiliation Additional Information");
076       } catch(HL7Exception e) {
077          log.error("Unexpected error creating AFF - this is probably a bug in the source code generator.", e);
078       }
079    }
080
081
082
083    /**
084     * Returns
085     * AFF-1: "Set ID - AFF" - creates it if necessary
086     */
087    public SI getSetIDAFF() { 
088                SI retVal = this.getTypedField(1, 0);
089                return retVal;
090    }
091    
092    /**
093     * Returns
094     * AFF-1: "Set ID - AFF" - creates it if necessary
095     */
096    public SI getAff1_SetIDAFF() { 
097                SI retVal = this.getTypedField(1, 0);
098                return retVal;
099    }
100
101
102
103    /**
104     * Returns
105     * AFF-2: "Professional Organization" - creates it if necessary
106     */
107    public XON getProfessionalOrganization() { 
108                XON retVal = this.getTypedField(2, 0);
109                return retVal;
110    }
111    
112    /**
113     * Returns
114     * AFF-2: "Professional Organization" - creates it if necessary
115     */
116    public XON getAff2_ProfessionalOrganization() { 
117                XON retVal = this.getTypedField(2, 0);
118                return retVal;
119    }
120
121
122
123    /**
124     * Returns
125     * AFF-3: "Professional Organization Address" - creates it if necessary
126     */
127    public XAD getProfessionalOrganizationAddress() { 
128                XAD retVal = this.getTypedField(3, 0);
129                return retVal;
130    }
131    
132    /**
133     * Returns
134     * AFF-3: "Professional Organization Address" - creates it if necessary
135     */
136    public XAD getAff3_ProfessionalOrganizationAddress() { 
137                XAD retVal = this.getTypedField(3, 0);
138                return retVal;
139    }
140
141
142    /**
143     * Returns all repetitions of Professional Organization Affiliation Date Range (AFF-4).
144     */
145    public DR[] getProfessionalOrganizationAffiliationDateRange() {
146        DR[] retVal = this.getTypedField(4, new DR[0]);
147        return retVal;
148    }
149
150
151    /**
152     * Returns all repetitions of Professional Organization Affiliation Date Range (AFF-4).
153     */
154    public DR[] getAff4_ProfessionalOrganizationAffiliationDateRange() {
155        DR[] retVal = this.getTypedField(4, new DR[0]);
156        return retVal;
157    }
158
159
160    /**
161     * Returns a count of the current number of repetitions of Professional Organization Affiliation Date Range (AFF-4).
162     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
163     * it will return zero.
164     */
165    public int getProfessionalOrganizationAffiliationDateRangeReps() {
166        return this.getReps(4);
167    }
168
169
170    /**
171     * Returns a specific repetition of
172     * AFF-4: "Professional Organization Affiliation Date Range" - creates it if necessary
173     *
174     * @param rep The repetition index (0-indexed)
175     */
176    public DR getProfessionalOrganizationAffiliationDateRange(int rep) { 
177                DR retVal = this.getTypedField(4, rep);
178                return retVal;
179    }
180
181    /**
182     * Returns a specific repetition of
183     * AFF-4: "Professional Organization Affiliation Date Range" - creates it if necessary
184     *
185     * @param rep The repetition index (0-indexed)
186     */
187    public DR getAff4_ProfessionalOrganizationAffiliationDateRange(int rep) { 
188                DR retVal = this.getTypedField(4, rep);
189                return retVal;
190    }
191
192    /**
193     * Returns a count of the current number of repetitions of Professional Organization Affiliation Date Range (AFF-4).
194     * This method does not create a repetition, so if no repetitions have currently been defined or accessed,
195     * it will return zero.
196     */
197    public int getAff4_ProfessionalOrganizationAffiliationDateRangeReps() {
198        return this.getReps(4);
199    }
200
201
202    /**
203     * Inserts a repetition of
204     * AFF-4: "Professional Organization Affiliation Date Range" 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 DR insertProfessionalOrganizationAffiliationDateRange(int rep) throws HL7Exception { 
210        return (DR) super.insertRepetition(4, rep);
211    }
212
213
214    /**
215     * Inserts a repetition of
216     * AFF-4: "Professional Organization Affiliation Date Range" 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 DR insertAff4_ProfessionalOrganizationAffiliationDateRange(int rep) throws HL7Exception { 
222        return (DR) super.insertRepetition(4, rep);
223    }
224
225
226    /**
227     * Removes a repetition of
228     * AFF-4: "Professional Organization Affiliation Date Range" at a specific index
229     *
230     * @param rep The repetition index (0-indexed)
231     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
232     */
233    public DR removeProfessionalOrganizationAffiliationDateRange(int rep) throws HL7Exception { 
234        return (DR) super.removeRepetition(4, rep);
235    }
236
237
238    /**
239     * Removes a repetition of
240     * AFF-4: "Professional Organization Affiliation Date Range" at a specific index
241     *
242     * @param rep The repetition index (0-indexed)
243     * @throws HL7Exception If the rep is invalid (below 0, or too high for the allowable repetitions)
244     */
245    public DR removeAff4_ProfessionalOrganizationAffiliationDateRange(int rep) throws HL7Exception { 
246        return (DR) super.removeRepetition(4, rep);
247    }
248
249
250
251
252    /**
253     * Returns
254     * AFF-5: "Professional Affiliation Additional Information" - creates it if necessary
255     */
256    public ST getProfessionalAffiliationAdditionalInformation() { 
257                ST retVal = this.getTypedField(5, 0);
258                return retVal;
259    }
260    
261    /**
262     * Returns
263     * AFF-5: "Professional Affiliation Additional Information" - creates it if necessary
264     */
265    public ST getAff5_ProfessionalAffiliationAdditionalInformation() { 
266                ST retVal = this.getTypedField(5, 0);
267                return retVal;
268    }
269
270
271
272
273
274    /** {@inheritDoc} */   
275    protected Type createNewTypeWithoutReflection(int field) {
276       switch (field) {
277          case 0: return new SI(getMessage());
278          case 1: return new XON(getMessage());
279          case 2: return new XAD(getMessage());
280          case 3: return new DR(getMessage());
281          case 4: return new ST(getMessage());
282          default: return null;
283       }
284   }
285
286
287}
288