xref: /AOO41X/main/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_configuration_backend_MergeRecoveryRequest_idl__
#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__

#ifndef __com_sun_star_uno_Exception_idl__
#include <com/sun/star/uno/Exception.idl>
#endif

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

module com { module sun { module star { module configuration { module backend {

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

/** is passed to an <type>InteractionHandler<type> when merging fails due to
	invalid layer data or access problems.

    @since OOo 2.0
 */
exception MergeRecoveryRequest: ::com::sun::star::uno::Exception
{
    /**
        data that provides more detailed information about the
        reason and location of the error.

        <p> Typically this member should contain an exception characterizing
            the error in detail.
        </p>
        <p> For example the following exceptions may be used:
        <dl>
            <dt><type>MalformedException</type></dt>
            <dd>for layers containing invalid data.</dd>

            <dt><type>BackendAccessException</type></dt>
            <dd>for layers that can't be accessed.</dd>
        </dl>
        </p>
        <p> If no more detail information is available, this may be left <void/>.
        </p>
    */
	any ErrorDetails;

    /**
        Identifier of the layer object containing the invalid data.
    */
    string ErrorLayerId;

    /**
        specifies whether the requestor wants to remove or skip the invalid layer.

        <p> If <TRUE/> the requestor wants to remove the underlying data of
            the layer.<BR/>
            If <FALSE/> the request is to skip the underlying data this time,
            but without removing it.
        </p>
    */
    boolean IsRemovalRequest;

};

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

}; }; }; }; };

#endif