001/**
002The contents of this file are subject to the Mozilla Public License Version 1.1 
003(the "License"); you may not use this file except in compliance with the License. 
004You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005Software distributed under the License is distributed on an "AS IS" basis, 
006WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007specific language governing rights and limitations under the License. 
008
009The Original Code is "Application.java".  Description: 
010"From an HL7 messaging perspective, a consumer of a messages" 
011
012The Initial Developer of the Original Code is University Health Network. Copyright (C) 
0132002.  All Rights Reserved. 
014
015Contributor(s): ______________________________________. 
016
017Alternatively, the contents of this file may be used under the terms of the 
018GNU General Public License (the  �GPL�), in which case the provisions of the GPL are 
019applicable instead of those above.  If you wish to allow use of your version of this 
020file only under the terms of the GPL and not to allow others to use your version 
021of this file under the MPL, indicate your decision by deleting  the provisions above 
022and replace  them with the notice and other provisions required by the GPL License.  
023If you do not delete the provisions above, a recipient may use your version of 
024this file under either the MPL or the GPL. 
025 */
026
027package ca.uhn.hl7v2.app;
028
029import ca.uhn.hl7v2.HL7Exception;
030import ca.uhn.hl7v2.model.Message;
031
032/**
033 * The Interface ApplicationExceptionHandler. Allow applications to handle
034 * parsing and handling errors
035 * 
036 * @author Gabriel Landais
037 * @see Application
038 */
039public interface ApplicationExceptionHandler<T extends Message> extends Application<T> {
040
041        /**
042         * Process an exception.
043         * 
044         * @param incomingMessage
045         *            the incoming message. This is the raw message which was
046         *            received from the external system
047         * @param outgoingMessage
048         *            the outgoing message. The response NAK message generated by
049         *            HAPI.
050         * @param e
051         *            the exception
052         * @return The new outgoing message. This can be set to the value provided
053         *         by HAPI in <code>outgoingMessage</code>, or may be replaced with
054         *         another message.
055         */
056        public String processException(String incomingMessage, String outgoingMessage, Exception e) throws HL7Exception;
057
058}