offapi/com/sun/star/script/XStorageBasedLibraryContainer.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: XStorageBasedLibraryContainer.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
  31
  32 #ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
  33 #define __com_sun_star_script_XStorageBasedLibraryContainer_idl__
  34
  35 #ifndef __com_sun_star_embed_XStorage_idl__
  36 #include <com/sun/star/embed/XStorage.idl>
  37 #endif
  38 #ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__
  39 #include <com/sun/star/script/XPersistentLibraryContainer.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module script {
  45
  46 //=============================================================================
  47
  48 /** is the interface for an <type>XLibraryContainer</type> which can be made
  49     persistent in an <type scope="com::sun::star::embed">XStorage</type>.
  50
  51     <p>A persistent library container is associated with a root storage. The
  52     container is responsible for a particular sub storage of the root storage,
  53     the container storage.</p>
  54
  55     @since OOo 2.3
  56  */
  57 interface XStorageBasedLibraryContainer
  58 {
  59     interface XPersistentLibraryContainer;
  60
  61     /** denotes the root storage associated with the container.
  62
  63         <p>Effectively, this attribute is a typed version of
  64         <member>XPersistentLibraryContainer::RootLocation</member>, it's guaranteed
  65         that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and
  66         <code>RootStorage</code> have the same value.</p>
  67
  68         <p>You should only <em>set</em> this attribute to a new value if you previously
  69         called storeLibrariesToStorage with the same storage. Setting this attribute
  70         to a storage into which the container has not been stored previously might
  71         result in unexpected behaviour.</p>
  72     */
  73     [attribute] ::com::sun::star::embed::XStorage RootStorage
  74     {
  75         set raises ( ::com::sun::star::lang::IllegalArgumentException );
  76     };
  77
  78     /** stores the libraries to a storage other than the current container storage
  79
  80         <p>Note that the library continer is not automatically associated with the
  81         new root storage. Instead, you need to manually set the <type>RootStroage</type>
  82         attribute afterwards. This separation allows for Save-To as well Save-As
  83         operations.</p>
  84
  85         @param RootStorage
  86             denotes the root storage into which the libraries should be written, which
  87             must not be <NULL/>.<br/>
  88             Note that the actual libraries are written into a sub storage of this
  89             root storage, as usual.
  90
  91         @throws ::com::sun::star::lang::IllegalArgumentException
  92             if the <code>RootStorage</code> parameter is <NULL/>, or equals
  93             <member>RootStorage</member>.
  94
  95         @throws ::com::sun::star::lang::WrappedTargetException
  96             if an error occurs during storing.
  97     */
  98     void    storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage RootStorage )
  99         raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
 100 };
 101
 102 //=============================================================================
 103
 104 }; }; }; };
 105
 106 //=============================================================================
 107
 108 #endif