offapi/com/sun/star/embed/XCommonEmbedPersist.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_XCommonEmbedPersist_idl__
  20 #define __com_sun_star_embed_XCommonEmbedPersist_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/embed/XStorage.idl>
  24 #include <com/sun/star/io/IOException.idl>
  25 #include <com/sun/star/embed/WrongStateException.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27 #include <com/sun/star/beans/PropertyValue.idl>
  28
  29
  30  module com {  module sun {  module star {  module embed {
  31
  32 /** specifies common implementation for embedded objects and links
  33     persistence.
  34  */
  35 published interface XCommonEmbedPersist: com::sun::star::uno::XInterface
  36 {
  37     /** lets the object or the link store itself.
  38
  39         @throws com::sun::star::embed::WrongStateException
  40             the object is in wrong state
  41
  42         @throws com::sun::star::io::IOException
  43             in case of io problems during saving
  44
  45         @throws com::sun::star::uno::Exception
  46             in case of other problems
  47      */
  48     void storeOwn()
  49         raises( ::com::sun::star::embed::WrongStateException,
  50                 ::com::sun::star::io::IOException,
  51                 ::com::sun::star::uno::Exception );
  52
  53     /** allows to detect if the data store is read-only.
  54
  55         @returns
  56             `TRUE` if the data store is readonly or opened readonly
  57             `FALSE` otherwise
  58
  59         @throws com::sun::star::embed::WrongStateException
  60             the object is in wrong state ( has no entry )
  61      */
  62     boolean isReadonly()
  63         raises( ::com::sun::star::embed::WrongStateException );
  64
  65     /** lets the object or the link reload itself.
  66
  67         <p>
  68         If the object has persistence it will be reloaded from its persistent
  69         entry.
  70         </p>
  71
  72         @param aMediaArgs
  73             optional parameters for document reloading, see also
  74             com::sun::star::document::MediaDescriptor
  75
  76         @param aObjectArgs
  77             optional parameters for object reloading, see also
  78             com::sun::star::embed::EmbeddedObjectDescriptor
  79
  80         @throws ::com::sun::star::lang::IllegalArgumentException
  81             one of arguments is illegal
  82
  83         @throws com::sun::star::embed::WrongStateException
  84             the object is in wrong state
  85
  86         @throws com::sun::star::io::IOException
  87             in case of io problems during opening or creation
  88
  89         @throws com::sun::star::uno::Exception
  90             in case of other problems
  91      */
  92     void reload(
  93             [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
  94             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
  95         raises( ::com::sun::star::lang::IllegalArgumentException,
  96                 ::com::sun::star::embed::WrongStateException,
  97                 ::com::sun::star::io::IOException,
  98                 ::com::sun::star::uno::Exception );
  99 };
 100
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */