xref: /trunk/main/offapi/com/sun/star/util/XLockable.idl (revision d5bd2f9e) 
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
24#ifndef __com_sun_star_util_XLockable_idl__
25#define __com_sun_star_util_XLockable_idl__
26
27#include <com/sun/star/util/NotLockedException.idl>
28
29//==================================================================================================================
30
31module com { module sun { module star { module util {
32
33//==================================================================================================================
34
35/** allows locking a component
36
37    <p><code>lock</code> and <code>unlock</code> calls can be nested. However, they must be in
38    pairs. As long as there has been one more call to <code>lock</code> than to <code>unlock</code>, the
39    component is considered locked, which is reflected by <member>isLocked</member> returning <TRUE/>.</p>
40 */
41published interface XLockable
42{
43    /** locks</a> the component
44
45        @see unlock
46        @see isLocked
47    */
48    void    lock();
49
50    /** unlocks the component
51
52        @throws NotLockedException
53            if the component is not currently locked.
54
55        @see lock
56        @see isLocked
57    */
58    void    unlock()
59        raises  (   NotLockedException
60                );
61
62    /** determines whether the component is currently locked.
63
64        @see lock
65        @see unlock
66    */
67    boolean isLocked();
68};
69
70//==================================================================================================================
71
72}; }; }; };
73
74//==================================================================================================================
75
76#endif
77