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#ifndef __com_sun_star_script_XLibraryContainer_idl__
28#define __com_sun_star_script_XLibraryContainer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_container_XNameContainer_idl__
35#include <com/sun/star/container/XNameContainer.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42#ifndef __com_sun_star_container_NoSuchElementException_idl__
43#include <com/sun/star/container/NoSuchElementException.idl>
44#endif
45
46#ifndef __com_sun_star_container_ElementExistException_idl__
47#include <com/sun/star/container/ElementExistException.idl>
48#endif
49
50#ifndef __com_sun_star_lang_WrappedTargetException_idl__
51#include <com/sun/star/lang/WrappedTargetException.idl>
52#endif
53
54#ifndef __com_sun_star_container_ElementExistException_idl__
55#include <com/sun/star/container/ElementExistException.idl>
56#endif
57#ifndef __com_sun_star_lang_WrappedTargetException_idl__
58#include <com/sun/star/lang/WrappedTargetException.idl>
59#endif
60
61
62//=============================================================================
63
64module com {  module sun {  module star {  module script {
65
66//=============================================================================
67
68/**
69	Provides access to a library system.
70 */
71published interface XLibraryContainer: com::sun::star::container::XNameAccess
72{
73	/**
74		Creates a new library
75	 */
76	com::sun::star::container::XNameContainer createLibrary( [in] string Name )
77		raises( com::sun::star::lang::IllegalArgumentException,
78				com::sun::star::container::ElementExistException );
79
80	/**
81		Creates a link to an "external" library that then can be
82		accessed using this library manager. The format of the
83		StorageURL is a matter of the implementation. If the read
84		only flag is set, the linked library cannot be modified.
85		In this case, the returned interface really is only an
86		XNameAccess. If ReadOnly is false (and the referenced
87		storage allows write access) the returned interface also
88		can be a <type scope="com::sun::star::container">XNameContainer</type>.
89	 */
90	com::sun::star::container::XNameAccess createLibraryLink( [in] string Name, [in] string StorageURL, [in] boolean ReadOnly )
91		raises( com::sun::star::lang::IllegalArgumentException,
92				com::sun::star::container::ElementExistException );
93
94	/** removes the library item with the specified name. If the accessed
95		library item is a link only the link is removed, not the target library.
96	 */
97	void removeLibrary( [in] string Name )
98			raises( com::sun::star::container::NoSuchElementException,
99					com::sun::star::lang::WrappedTargetException );
100
101	/**
102		returns true if the accessed library is already loaded from
103		the storage, otherwise false.
104	 */
105	boolean isLibraryLoaded( [in] string Name )
106			raises( com::sun::star::container::NoSuchElementException );
107
108	/**
109		Causes the accessed library to be loaded from its storage
110		if it hasn't already been loaded.
111	 */
112	void loadLibrary( [in] string Name )
113			raises( com::sun::star::container::NoSuchElementException,
114					com::sun::star::lang::WrappedTargetException );
115
116};
117
118//=============================================================================
119
120
121}; }; }; };
122
123#endif
124