offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MergeRecoveryRequest.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__
  31 #define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__
  32
  33 #ifndef __com_sun_star_uno_Exception_idl__
  34 #include <com/sun/star/uno/Exception.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module configuration { module backend {
  40
  41 //=============================================================================
  42
  43 /** is passed to an <type>InteractionHandler<type> when merging fails due to
  44     invalid layer data or access problems.
  45
  46     @since OOo 2.0.0
  47  */
  48 exception MergeRecoveryRequest: ::com::sun::star::uno::Exception
  49 {
  50     /**
  51         data that provides more detailed information about the
  52         reason and location of the error.
  53
  54         <p> Typically this member should contain an exception characterizing
  55             the error in detail.
  56         </p>
  57         <p> For example the following exceptions may be used:
  58         <dl>
  59             <dt><type>MalformedException</type></dt>
  60             <dd>for layers containing invalid data.</dd>
  61
  62             <dt><type>BackendAccessException</type></dt>
  63             <dd>for layers that can't be accessed.</dd>
  64         </dl>
  65         </p>
  66         <p> If no more detail information is available, this may be left <void/>.
  67         </p>
  68     */
  69     any ErrorDetails;
  70
  71     /**
  72         Identifier of the layer object containing the invalid data.
  73     */
  74     string ErrorLayerId;
  75
  76     /**
  77         specifies whether the requestor wants to remove or skip the invalid layer.
  78
  79         <p> If <TRUE/> the requestor wants to remove the underlying data of
  80             the layer.<BR/>
  81             If <FALSE/> the request is to skip the underlying data this time,
  82             but without removing it.
  83         </p>
  84     */
  85     boolean IsRemovalRequest;
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; }; };
  92
  93 #endif