| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_embed_XCommonEmbedPersist_idl__ |
| #define __com_sun_star_embed_XCommonEmbedPersist_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| #ifndef __com_sun_star_embed_XStorage_idl__ |
| #include <com/sun/star/embed/XStorage.idl> |
| #endif |
| |
| #ifndef __com_sun_star_io_IOException_idl__ |
| #include <com/sun/star/io/IOException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_embed_WrongStateException_idl__ |
| #include <com/sun/star/embed/WrongStateException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_PropertyValue_idl__ |
| #include <com/sun/star/beans/PropertyValue.idl> |
| #endif |
| |
| //============================================================================ |
| |
| module com { module sun { module star { module embed { |
| |
| //============================================================================ |
| /** specifies common implementation for embedded objects and links |
| persistence. |
| */ |
| published interface XCommonEmbedPersist: com::sun::star::uno::XInterface |
| { |
| //------------------------------------------------------------------------ |
| /** lets the object or the link store itself. |
| |
| @throws com::sun::star::embed::WrongStateException |
| the object is in wrong state |
| |
| @throws com::sun::star::io::IOException |
| in case of io problems during saving |
| |
| @throws com::sun::star::uno::Exception |
| in case of other problems |
| */ |
| void storeOwn() |
| raises( ::com::sun::star::embed::WrongStateException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::uno::Exception ); |
| |
| //------------------------------------------------------------------------ |
| /** allows to detect if the data store is read-only. |
| |
| @returns |
| <TRUE/> if the data store is readonly or opened readonly |
| <FALSE/> otherwise |
| |
| @throws com::sun::star::embed::WrongStateException |
| the object is in wrong state ( has no entry ) |
| */ |
| boolean isReadonly() |
| raises( ::com::sun::star::embed::WrongStateException ); |
| |
| //------------------------------------------------------------------------ |
| /** lets the object or the link reload itself. |
| |
| <p> |
| If the object has persistence it will be reloaded from it's persistant |
| entry. |
| </p> |
| |
| @param aMediaArgs |
| optional parameters for document reloading, see also |
| <type scope="com::sun::star::document">MediaDescriptor</type> |
| |
| @param aObjectArgs |
| optional parameters for object reloading, see also |
| <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type> |
| |
| @thrown ::com::sun::star::lang::IllegalArgumentException |
| one of arguments is illegal |
| |
| @throws com::sun::star::embed::WrongStateException |
| the object is in wrong state |
| |
| @throws com::sun::star::io::IOException |
| in case of io problems during opening\creation |
| |
| @throws com::sun::star::uno::Exception |
| in case of other problems |
| */ |
| void reload( |
| [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs, |
| [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs ) |
| raises( ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::embed::WrongStateException, |
| ::com::sun::star::io::IOException, |
| ::com::sun::star::uno::Exception ); |
| }; |
| |
| //============================================================================ |
| |
| }; }; }; }; |
| |
| #endif |
| |