offapi/com/sun/star/embed/XCommonEmbedPersist.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: XCommonEmbedPersist.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_XCommonEmbedPersist_idl__
  31 #define __com_sun_star_embed_XCommonEmbedPersist_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_embed_XStorage_idl__
  38 #include <com/sun/star/embed/XStorage.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_io_IOException_idl__
  42 #include <com/sun/star/io/IOException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_embed_WrongStateException_idl__
  46 #include <com/sun/star/embed/WrongStateException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  50 #include <com/sun/star/lang/IllegalArgumentException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_PropertyValue_idl__
  54 #include <com/sun/star/beans/PropertyValue.idl>
  55 #endif
  56
  57 //============================================================================
  58
  59  module com {  module sun {  module star {  module embed {
  60
  61 //============================================================================
  62 /** specifies common implementation for embedded objects and links
  63     persistence.
  64  */
  65 interface XCommonEmbedPersist: com::sun::star::uno::XInterface
  66 {
  67      //------------------------------------------------------------------------
  68     /** lets the object or the link store itself.
  69
  70         @throws com::sun::star::embed::WrongStateException
  71             the object is in wrong state
  72
  73         @throws com::sun::star::io::IOException
  74             in case of io problems during saving
  75
  76         @throws com::sun::star::uno::Exception
  77             in case of other problems
  78      */
  79     void storeOwn()
  80         raises( ::com::sun::star::embed::WrongStateException,
  81                 ::com::sun::star::io::IOException,
  82                 ::com::sun::star::uno::Exception );
  83
  84     //------------------------------------------------------------------------
  85     /** allows to detect if the data store is read-only.
  86
  87         @returns
  88             <TRUE/> if the data store is readonly or opened readonly
  89             <FALSE/> otherwise
  90
  91         @throws com::sun::star::embed::WrongStateException
  92             the object is in wrong state ( has no entry )
  93      */
  94     boolean isReadonly()
  95         raises( ::com::sun::star::embed::WrongStateException );
  96
  97     //------------------------------------------------------------------------
  98     /** lets the object or the link reload itself.
  99
 100         <p>
 101         If the object has persistance it will be reloaded from it's persistant
 102         entry.
 103         </p>
 104
 105         @param aMediaArgs
 106             optional parameters for document reloading, see also
 107             <type scope="com::sun::star::document">MediaDescriptor</type>
 108
 109         @param aObjectArgs
 110             optional parameters for object reloading, see also
 111             <type scope="com::sun::star::embed">EmbeddedObjectDescriptor</type>
 112
 113         @thrown ::com::sun::star::lang::IllegalArgumentException
 114             one of arguments is illegal
 115
 116         @throws com::sun::star::embed::WrongStateException
 117             the object is in wrong state
 118
 119         @throws com::sun::star::io::IOException
 120             in case of io problems during opening\creation
 121
 122         @throws com::sun::star::uno::Exception
 123             in case of other problems
 124      */
 125     void reload(
 126             [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaArgs,
 127             [in] sequence< ::com::sun::star::beans::PropertyValue > aObjectArgs )
 128         raises( ::com::sun::star::lang::IllegalArgumentException,
 129                 ::com::sun::star::embed::WrongStateException,
 130                 ::com::sun::star::io::IOException,
 131                 ::com::sun::star::uno::Exception );
 132 };
 133
 134 //============================================================================
 135
 136 }; }; }; };
 137
 138 #endif
 139