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/**
049 *<p>Represents an HL7 MSA message segment (MESSAGE ACKNOWLEDGMENT). 
050 * This segment has the following fields:</p>
051 * <ul>
052     * <li>MSA-1: Acknowledgement code (ID) <b> </b>
053     * <li>MSA-2: Message Control ID (ST) <b> </b>
054     * <li>MSA-3: Text Message (ST) <b>optional </b>
055     * <li>MSA-4: Expected Sequence Number (NM) <b>optional </b>
056     * <li>MSA-5: Delayed Acknowledgement type (ID) <b>optional </b>
057     * <li>MSA-6: Error Condition (CE) <b>optional </b>
058 * </ul>
059 */
060@SuppressWarnings("unused")
061public class MSA extends AbstractSegment {
062
063    /** 
064     * Creates a new MSA segment
065     */
066    public MSA(Group parent, ModelClassFactory factory) {
067       super(parent, factory);
068       init(factory);
069    }
070
071    private void init(ModelClassFactory factory) {
072       try {
073                                              this.add(ID.class, true, 1, 2, new Object[]{ getMessage(), new Integer(8) }, "Acknowledgement code");
074                                  this.add(ST.class, true, 1, 20, new Object[]{ getMessage() }, "Message Control ID");
075                                  this.add(ST.class, false, 1, 80, new Object[]{ getMessage() }, "Text Message");
076                                  this.add(NM.class, false, 1, 15, new Object[]{ getMessage() }, "Expected Sequence Number");
077                                              this.add(ID.class, false, 1, 1, new Object[]{ getMessage(), new Integer(102) }, "Delayed Acknowledgement type");
078                                  this.add(CE.class, false, 1, 100, new Object[]{ getMessage() }, "Error Condition");
079       } catch(HL7Exception e) {
080          log.error("Unexpected error creating MSA - this is probably a bug in the source code generator.", e);
081       }
082    }
083
084
085
086    /**
087     * Returns
088     * MSA-1: "Acknowledgement code" - creates it if necessary
089     */
090    public ID getAcknowledgementCode() { 
091                ID retVal = this.getTypedField(1, 0);
092                return retVal;
093    }
094    
095    /**
096     * Returns
097     * MSA-1: "Acknowledgement code" - creates it if necessary
098     */
099    public ID getMsa1_AcknowledgementCode() { 
100                ID retVal = this.getTypedField(1, 0);
101                return retVal;
102    }
103
104
105
106    /**
107     * Returns
108     * MSA-2: "Message Control ID" - creates it if necessary
109     */
110    public ST getMessageControlID() { 
111                ST retVal = this.getTypedField(2, 0);
112                return retVal;
113    }
114    
115    /**
116     * Returns
117     * MSA-2: "Message Control ID" - creates it if necessary
118     */
119    public ST getMsa2_MessageControlID() { 
120                ST retVal = this.getTypedField(2, 0);
121                return retVal;
122    }
123
124
125
126    /**
127     * Returns
128     * MSA-3: "Text Message" - creates it if necessary
129     */
130    public ST getTextMessage() { 
131                ST retVal = this.getTypedField(3, 0);
132                return retVal;
133    }
134    
135    /**
136     * Returns
137     * MSA-3: "Text Message" - creates it if necessary
138     */
139    public ST getMsa3_TextMessage() { 
140                ST retVal = this.getTypedField(3, 0);
141                return retVal;
142    }
143
144
145
146    /**
147     * Returns
148     * MSA-4: "Expected Sequence Number" - creates it if necessary
149     */
150    public NM getExpectedSequenceNumber() { 
151                NM retVal = this.getTypedField(4, 0);
152                return retVal;
153    }
154    
155    /**
156     * Returns
157     * MSA-4: "Expected Sequence Number" - creates it if necessary
158     */
159    public NM getMsa4_ExpectedSequenceNumber() { 
160                NM retVal = this.getTypedField(4, 0);
161                return retVal;
162    }
163
164
165
166    /**
167     * Returns
168     * MSA-5: "Delayed Acknowledgement type" - creates it if necessary
169     */
170    public ID getDelayedAcknowledgementType() { 
171                ID retVal = this.getTypedField(5, 0);
172                return retVal;
173    }
174    
175    /**
176     * Returns
177     * MSA-5: "Delayed Acknowledgement type" - creates it if necessary
178     */
179    public ID getMsa5_DelayedAcknowledgementType() { 
180                ID retVal = this.getTypedField(5, 0);
181                return retVal;
182    }
183
184
185
186    /**
187     * Returns
188     * MSA-6: "Error Condition" - creates it if necessary
189     */
190    public CE getErrorCondition() { 
191                CE retVal = this.getTypedField(6, 0);
192                return retVal;
193    }
194    
195    /**
196     * Returns
197     * MSA-6: "Error Condition" - creates it if necessary
198     */
199    public CE getMsa6_ErrorCondition() { 
200                CE retVal = this.getTypedField(6, 0);
201                return retVal;
202    }
203
204
205
206
207
208    /** {@inheritDoc} */   
209    protected Type createNewTypeWithoutReflection(int field) {
210       switch (field) {
211          case 0: return new ID(getMessage(), new Integer( 8 ));
212          case 1: return new ST(getMessage());
213          case 2: return new ST(getMessage());
214          case 3: return new NM(getMessage());
215          case 4: return new ID(getMessage(), new Integer( 102 ));
216          case 5: return new CE(getMessage());
217          default: return null;
218       }
219   }
220
221
222}
223