1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_script_XLibraryContainer2_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_script_XLibraryContainer2_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_script_XLibraryContainer_idl__
27*b1cdbd2cSJim Jagielski#include <com/sun/star/script/XLibraryContainer.idl>
28*b1cdbd2cSJim Jagielski#endif
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski//=============================================================================
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski module com {  module sun {  module star {  module script {
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski//=============================================================================
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski/**
38*b1cdbd2cSJim Jagielski	Extension of <type>XLibraryContainer</type> to provide additional information
39*b1cdbd2cSJim Jagielski	about the libraries contained in a library container
40*b1cdbd2cSJim Jagielski */
41*b1cdbd2cSJim Jagielskipublished interface XLibraryContainer2: com::sun::star::script::XLibraryContainer
42*b1cdbd2cSJim Jagielski{
43*b1cdbd2cSJim Jagielski	/**
44*b1cdbd2cSJim Jagielski		returns true if the accessed library item is a link,
45*b1cdbd2cSJim Jagielski		e.g., created by createLibraryLink, otherwise false.
46*b1cdbd2cSJim Jagielski	 */
47*b1cdbd2cSJim Jagielski	boolean isLibraryLink( [in] string Name )
48*b1cdbd2cSJim Jagielski			raises( com::sun::star::container::NoSuchElementException );
49*b1cdbd2cSJim Jagielski
50*b1cdbd2cSJim Jagielski	/**
51*b1cdbd2cSJim Jagielski		returns the location of the library link target.
52*b1cdbd2cSJim Jagielski		Should return the same URL that was passed to
53*b1cdbd2cSJim Jagielski		createLibraryLink in the StorageURL parameter.
54*b1cdbd2cSJim Jagielski
55*b1cdbd2cSJim Jagielski		If the accessed library item exists but isn't a
56*b1cdbd2cSJim Jagielski		link, a IllegalArgumentException is thrown
57*b1cdbd2cSJim Jagielski	 */
58*b1cdbd2cSJim Jagielski	string getLibraryLinkURL( [in] string Name )
59*b1cdbd2cSJim Jagielski			raises( com::sun::star::lang::IllegalArgumentException,
60*b1cdbd2cSJim Jagielski					com::sun::star::container::NoSuchElementException );
61*b1cdbd2cSJim Jagielski
62*b1cdbd2cSJim Jagielski	/**
63*b1cdbd2cSJim Jagielski		returns true if the accessed library item (library or library
64*b1cdbd2cSJim Jagielski		link) is read only. A library can be read only because it was
65*b1cdbd2cSJim Jagielski		set to read only using the methods provided by this interface
66*b1cdbd2cSJim Jagielski		or because of other reasons depending on the implementation
67*b1cdbd2cSJim Jagielski		(e.g., file system write protection)
68*b1cdbd2cSJim Jagielski	 */
69*b1cdbd2cSJim Jagielski	boolean isLibraryReadOnly( [in] string Name )
70*b1cdbd2cSJim Jagielski			raises( com::sun::star::container::NoSuchElementException );
71*b1cdbd2cSJim Jagielski
72*b1cdbd2cSJim Jagielski	/**
73*b1cdbd2cSJim Jagielski		Sets the accessed library item (library or library link) to
74*b1cdbd2cSJim Jagielski		read only according to the flag bReadOnly (true means read only)
75*b1cdbd2cSJim Jagielski	 */
76*b1cdbd2cSJim Jagielski	void setLibraryReadOnly( [in] string Name, [in] boolean bReadOnly )
77*b1cdbd2cSJim Jagielski			raises( com::sun::star::container::NoSuchElementException );
78*b1cdbd2cSJim Jagielski
79*b1cdbd2cSJim Jagielski	/** renames the library item with the specified name. If the accessed
80*b1cdbd2cSJim Jagielski		library item is a link only the link is renamed, not the target library.
81*b1cdbd2cSJim Jagielski		If a library with the new name exists already a
82*b1cdbd2cSJim Jagielski		com::sun::star::container::ElementExistException is thrown.
83*b1cdbd2cSJim Jagielski	 */
84*b1cdbd2cSJim Jagielski	void renameLibrary( [in] string Name, [in] string NewName )
85*b1cdbd2cSJim Jagielski			raises( com::sun::star::container::NoSuchElementException,
86*b1cdbd2cSJim Jagielski					com::sun::star::container::ElementExistException );
87*b1cdbd2cSJim Jagielski
88*b1cdbd2cSJim Jagielski};
89*b1cdbd2cSJim Jagielski
90*b1cdbd2cSJim Jagielski//=============================================================================
91*b1cdbd2cSJim Jagielski
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski}; }; }; };
94*b1cdbd2cSJim Jagielski
95*b1cdbd2cSJim Jagielski#endif
96