/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XErrorHandler.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_sax_XErrorHandler_idl__
#define __com_sun_star_xml_sax_XErrorHandler_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_xml_sax_SAXException_idl__
#include <com/sun/star/xml/sax/SAXException.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module xml {  module sax {

//=============================================================================

/** is the basic interface for SAX error handlers.

    <p>If a SAX application needs to implement customized error handling,
    it must implement this interface and then register an instance with the
    SAX parser using the parser's <method>XParser::setErrorhandler</method>
    method. The parser will then report all errors and warnings through this
    interface.  </p>

    <p>This interface is a slight adaption of the Java interface
    <code>org.xml.sax.ErrorHandler</code>. In IDL, no exception can be passed
    as an argument, so an <code>any</code> serves as the container. The type of the
    exception is <type>SAXParseException</type> or an instance of a derived class.</p>
 */
published interface XErrorHandler: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** receives notification of a recoverable error.
     */
    void error( [in] any aSAXParseException )
            raises( com::sun::star::xml::sax::SAXException );

    //-------------------------------------------------------------------------
    /** receives notification of a non-recoverable error.
     */
    void fatalError( [in] any aSAXParseException )
            raises( com::sun::star::xml::sax::SAXException );

    //-------------------------------------------------------------------------
    /** receives notification of a warning.
     */
    void warning( [in] any aSAXParseException )
            raises( com::sun::star::xml::sax::SAXException );

};

//=============================================================================

}; }; }; }; };

#endif