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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_embed_UseBackupException_idl__
  20 #define __com_sun_star_embed_UseBackupException_idl__
  21
  22 #include <com/sun/star/io/IOException.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module embed {
  27
  28
  29 /** This exception can be thrown in case a storage commit is failed.
  30     <p>
  31     If a commit process of a storage fails on last transfer and the original
  32     content may be corrupted the storage should throw this exception to notify
  33     the user that a backup usage is required to restore the original content.
  34     </p>
  35
  36     <p>
  37     The storage itself must disconnect from the medium it is based on to allow
  38     restoring. Although the storage will still contain all the data
  39     internally, and can be used as a temporary storage usually used.
  40     </p>
  41  */
  42 published exception UseBackupException: com::sun::star::io::IOException
  43 {
  44     /** The URL of the temporary file the storage is based on now.
  45      */
  46     string TemporaryFileURL;
  47 };
  48
  49
  50 }; }; }; };
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */