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