1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_uno_XUnloadingPreference_idl__
24#define __com_sun_star_uno_XUnloadingPreference_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//=============================================================================
31
32module com {  module sun {  module star {  module uno {
33
34//=============================================================================
35/** Components can implement <code>XUnloadingPreference</code> in order to indicate
36	how they should be treated when their hosting library is to be unloaded.
37
38   When someone calls <code>rtl_unloadUnusedModules</code> then the unloading
39	listeners are notified by calling previously registered callback
40	functions. A listener is an entity that employs, registers, and
41	unregisters the callback functions on its behalf. Upon notification
42	(the callback function is being called)
43	a listener may release references to UNO components. Thus, the
44	loaded libraries can be unloaded, if no one else keeps any
45	objects from the library alive. <br>
46	Before a listener releases references, it should ask for this interface.
47	If the interface is not implemented, then the listener may release the
48	object; otherwise, it calls <code>releaseOnNotification</code>. If the function
49	returns false then the listener should keep the reference, otherwise
50	it may release it.
51*/
52published interface XUnloadingPreference: com::sun::star::uno::XInterface
53{
54	/**
55		The return value determines if the object wants to stay
56		alive in case of an unloading procedure.
57		@return
58		<FALSE/>do not release references to this object,otherwise
59		<TRUE/>
60	*/
61	boolean releaseOnNotification();
62};
63//=============================================================================
64
65}; }; }; };
66
67#endif
68