1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir
25cdf0e10cSrcweir#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
26cdf0e10cSrcweir#define __com_sun_star_script_XStorageBasedLibraryContainer_idl__
27cdf0e10cSrcweir
28cdf0e10cSrcweir#ifndef __com_sun_star_embed_XStorage_idl__
29cdf0e10cSrcweir#include <com/sun/star/embed/XStorage.idl>
30cdf0e10cSrcweir#endif
31cdf0e10cSrcweir#ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__
32cdf0e10cSrcweir#include <com/sun/star/script/XPersistentLibraryContainer.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com { module sun { module star { module script {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** is the interface for an <type>XLibraryContainer</type> which can be made
42cdf0e10cSrcweir    persistent in an <type scope="com::sun::star::embed">XStorage</type>.
43cdf0e10cSrcweir
44cdf0e10cSrcweir    <p>A persistent library container is associated with a root storage. The
45cdf0e10cSrcweir    container is responsible for a particular sub storage of the root storage,
46cdf0e10cSrcweir    the container storage.</p>
47cdf0e10cSrcweir
48cdf0e10cSrcweir    @since OOo 2.3
49cdf0e10cSrcweir */
50cdf0e10cSrcweirinterface XStorageBasedLibraryContainer
51cdf0e10cSrcweir{
52cdf0e10cSrcweir    interface XPersistentLibraryContainer;
53cdf0e10cSrcweir
54cdf0e10cSrcweir    /** denotes the root storage associated with the container.
55cdf0e10cSrcweir
56cdf0e10cSrcweir        <p>Effectively, this attribute is a typed version of
57cdf0e10cSrcweir        <member>XPersistentLibraryContainer::RootLocation</member>, it's guaranteed
58cdf0e10cSrcweir        that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and
59cdf0e10cSrcweir        <code>RootStorage</code> have the same value.</p>
60cdf0e10cSrcweir
61cdf0e10cSrcweir        <p>You should only <em>set</em> this attribute to a new value if you previously
62cdf0e10cSrcweir        called storeLibrariesToStorage with the same storage. Setting this attribute
63cdf0e10cSrcweir        to a storage into which the container has not been stored previously might
64cdf0e10cSrcweir        result in unexpected behaviour.</p>
65cdf0e10cSrcweir    */
66cdf0e10cSrcweir    [attribute] ::com::sun::star::embed::XStorage RootStorage
67cdf0e10cSrcweir    {
68cdf0e10cSrcweir        set raises ( ::com::sun::star::lang::IllegalArgumentException );
69cdf0e10cSrcweir    };
70cdf0e10cSrcweir
71cdf0e10cSrcweir    /** stores the libraries to a storage other than the current container storage
72cdf0e10cSrcweir
73cdf0e10cSrcweir        <p>Note that the library continer is not automatically associated with the
74cdf0e10cSrcweir        new root storage. Instead, you need to manually set the <type>RootStroage</type>
75cdf0e10cSrcweir        attribute afterwards. This separation allows for Save-To as well Save-As
76cdf0e10cSrcweir        operations.</p>
77cdf0e10cSrcweir
78cdf0e10cSrcweir        @param RootStorage
79cdf0e10cSrcweir            denotes the root storage into which the libraries should be written, which
80cdf0e10cSrcweir            must not be <NULL/>.<br/>
81cdf0e10cSrcweir            Note that the actual libraries are written into a sub storage of this
82cdf0e10cSrcweir            root storage, as usual.
83cdf0e10cSrcweir
84cdf0e10cSrcweir        @throws ::com::sun::star::lang::IllegalArgumentException
85cdf0e10cSrcweir            if the <code>RootStorage</code> parameter is <NULL/>, or equals
86cdf0e10cSrcweir            <member>RootStorage</member>.
87cdf0e10cSrcweir
88cdf0e10cSrcweir        @throws ::com::sun::star::lang::WrappedTargetException
89cdf0e10cSrcweir            if an error occurs during storing.
90cdf0e10cSrcweir    */
91cdf0e10cSrcweir    void    storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage RootStorage )
92cdf0e10cSrcweir        raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException );
93cdf0e10cSrcweir};
94cdf0e10cSrcweir
95cdf0e10cSrcweir//=============================================================================
96cdf0e10cSrcweir
97cdf0e10cSrcweir}; }; }; };
98cdf0e10cSrcweir
99cdf0e10cSrcweir//=============================================================================
100cdf0e10cSrcweir
101cdf0e10cSrcweir#endif
102