offapi/com/sun/star/embed/UseBackupException.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: UseBackupException.idl,v $
  10  * $Revision: 1.4 $
  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_embed_UseBackupException_idl__
  31 #define __com_sun_star_embed_UseBackupException_idl__
  32
  33 #ifndef __com_sun_star_io_IOException_idl__
  34 #include <com/sun/star/io/IOException.idl>
  35 #endif
  36
  37
  38 //============================================================================
  39
  40  module com {  module sun {  module star {  module embed {
  41
  42 //============================================================================
  43
  44 /** This exception can be thrown in case a storage commit is failed.
  45     <p>
  46     If a commit process of a storage failes on last transfer and the original
  47     content may be corrupted the storage should throw this exception to notify
  48     the user that a backup usage is required to restore the original content.
  49     </p>
  50
  51     <p>
  52     The storage itself must disconnect from the medium it is based on to allow
  53     restoring. Although the storage will still contain all the data
  54     internally, and can be used as a temporary storage usually used.
  55     </p>
  56  */
  57 exception UseBackupException: com::sun::star::io::IOException
  58 {
  59     /** The URL of the temporary file the storage is based on now.
  60      */
  61     string TemporaryFileURL;
  62 };
  63
  64 //============================================================================
  65
  66 }; }; }; };
  67
  68 #endif
  69