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_util_XProtectable_idl__
24#define __com_sun_star_util_XProtectable_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module util {
38
39//=============================================================================
40
41/** makes it possible to protect objects from modifications.
42 */
43published interface XProtectable: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46	/** activates the protection.
47
48		@param aPassword
49			a string to specify new password.
50	 */
51	void protect( [in] string aPassword );
52
53	//-------------------------------------------------------------------------
54	/** removes the protection.
55
56		@param aPassword
57			a string to match with the current password.
58		@throws com::sun::star::lang::IllegalArgumentException
59			if invalid password is specified.
60	 */
61	void unprotect( [in] string aPassword )
62			raises( com::sun::star::lang::IllegalArgumentException );
63
64	//-------------------------------------------------------------------------
65	/** @returns
66				the current state of protection.
67	 */
68	boolean isProtected();
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76#endif
77