xref: /trunk/main/offapi/com/sun/star/util/XProtectable.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_util_XProtectable_idl__
24cdf0e10cSrcweir#define __com_sun_star_util_XProtectable_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** makes it possible to protect objects from modifications.
42cdf0e10cSrcweir */
43cdf0e10cSrcweirpublished interface XProtectable: com::sun::star::uno::XInterface
44cdf0e10cSrcweir{
45cdf0e10cSrcweir    //-------------------------------------------------------------------------
46cdf0e10cSrcweir    /** activates the protection.
47*37b7d578STsutomu Uchino
48*37b7d578STsutomu Uchino        @param aPassword
49*37b7d578STsutomu Uchino            a string to specify new password.
50cdf0e10cSrcweir     */
51cdf0e10cSrcweir    void protect( [in] string aPassword );
52cdf0e10cSrcweir
53cdf0e10cSrcweir    //-------------------------------------------------------------------------
54cdf0e10cSrcweir    /** removes the protection.
55*37b7d578STsutomu Uchino
56*37b7d578STsutomu Uchino        @param aPassword
57*37b7d578STsutomu Uchino            a string to match with the current password.
58*37b7d578STsutomu Uchino        @throws com::sun::star::lang::IllegalArgumentException
59*37b7d578STsutomu Uchino            if invalid password is specified.
60cdf0e10cSrcweir     */
61cdf0e10cSrcweir    void unprotect( [in] string aPassword )
62cdf0e10cSrcweir            raises( com::sun::star::lang::IllegalArgumentException );
63cdf0e10cSrcweir
64cdf0e10cSrcweir    //-------------------------------------------------------------------------
65cdf0e10cSrcweir    /** @returns
66cdf0e10cSrcweir                the current state of protection.
67cdf0e10cSrcweir     */
68cdf0e10cSrcweir    boolean isProtected();
69cdf0e10cSrcweir
70cdf0e10cSrcweir};
71cdf0e10cSrcweir
72cdf0e10cSrcweir//=============================================================================
73cdf0e10cSrcweir
74cdf0e10cSrcweir}; }; }; };
75cdf0e10cSrcweir
76cdf0e10cSrcweir#endif
77