offapi/com/sun/star/embed/UseBackupException.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_embed_UseBackupException_idl__
  28 #define __com_sun_star_embed_UseBackupException_idl__
  29
  30 #ifndef __com_sun_star_io_IOException_idl__
  31 #include <com/sun/star/io/IOException.idl>
  32 #endif
  33
  34
  35 //============================================================================
  36
  37  module com {  module sun {  module star {  module embed {
  38
  39 //============================================================================
  40
  41 /** This exception can be thrown in case a storage commit is failed.
  42     <p>
  43     If a commit process of a storage failes on last transfer and the original
  44     content may be corrupted the storage should throw this exception to notify
  45     the user that a backup usage is required to restore the original content.
  46     </p>
  47
  48     <p>
  49     The storage itself must disconnect from the medium it is based on to allow
  50     restoring. Although the storage will still contain all the data
  51     internally, and can be used as a temporary storage usually used.
  52     </p>
  53  */
  54 published exception UseBackupException: com::sun::star::io::IOException
  55 {
  56     /** The URL of the temporary file the storage is based on now.
  57      */
  58     string TemporaryFileURL;
  59 };
  60
  61 //============================================================================
  62
  63 }; }; }; };
  64
  65 #endif
  66