offapi/com/sun/star/util/XProtectable.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_XProtectable_idl__
  20 #define __com_sun_star_util_XProtectable_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module util {
  29
  30
  31 /** makes it possible to protect objects from modifications.
  32  */
  33 published interface XProtectable: com::sun::star::uno::XInterface
  34 {
  35     /** activates the protection.
  36
  37         @param aPassword
  38             a string to specify new password.
  39      */
  40     void protect( [in] string aPassword );
  41
  42     /** removes the protection.
  43
  44         @param aPassword
  45             a string to match with the current password.
  46         @throws com::sun::star::lang::IllegalArgumentException
  47             if invalid password is specified.
  48      */
  49     void unprotect( [in] string aPassword )
  50             raises( com::sun::star::lang::IllegalArgumentException );
  51
  52     /** @returns
  53                 the current state of protection.
  54      */
  55     boolean isProtected();
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */