1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__
29#define __com_sun_star_script_XPersistentLibraryContainer_idl__
30
31#ifndef __com_sun_star_util_XModifiable_idl__
32#include <com/sun/star/util/XModifiable.idl>
33#endif
34#ifndef __com_sun_star_script_XLibraryContainer2_idl__
35#include <com/sun/star/script/XLibraryContainer2.idl>
36#endif
37#ifndef __com_sun_star_lang_WrappedTargetException_idl__
38#include <com/sun/star/lang/WrappedTargetException.idl>
39#endif
40
41//=============================================================================
42
43module com { module sun { module star { module script {
44
45//=============================================================================
46
47/** describes a container of script libraries which is persistent.
48
49    <p>The type of persistence of the container elements is not defined here,
50    but in derived interfaces or services using
51    <code>XPersistentLibraryContainer</code>.</p>
52
53    <p>The actual libraries are stored in some object - a sub folder, or a sub storage,
54    for example - below the root location.</p>
55
56    @since OOo 2.3
57 */
58interface XPersistentLibraryContainer
59{
60    interface ::com::sun::star::util::XModifiable;
61    interface XLibraryContainer2;
62
63    /** denotes the root location associated with the container.
64
65        <p>The type of this location - it might be a folder in a file system,
66        a storage, or anything else - is not specified here, but in derived interfaces
67        or services implementing <code>XPersistentLibraryContainer</code>.</p>
68
69        <p>All operations of the library container take place in a location below
70        the root location, the so-called container location, whose
71        name is exposed as <member>ContainerLocationName</member>.</p>
72
73        @see ContainerLocationName
74    */
75    [attribute, readonly] any   RootLocation;
76
77    /** denotes the name of the sub location where the container elements are
78        actually stored.
79
80        @see RootLocation
81    */
82    [attribute, readonly] string ContainerLocationName;
83
84    /** stores the libraries to the current location.
85
86        @throws ::com::sun::star::lang::WrappedTargetException
87            if an error occurs during storing.
88
89        @see RootLocation
90        @see ContainerLocationName
91    */
92    void    storeLibraries()
93        raises ( ::com::sun::star::lang::WrappedTargetException );
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101//=============================================================================
102
103#endif
104
105