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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_util_XProtectable_idl__
  28 #define __com_sun_star_util_XProtectable_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module util {
  42
  43 //=============================================================================
  44
  45 /** makes it possible to protect objects from modifications.
  46  */
  47 published interface XProtectable: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50     /** activates the protection.
  51      */
  52     void protect( [in] string aPassword );
  53
  54     //-------------------------------------------------------------------------
  55     /** removes the protection.
  56      */
  57     void unprotect( [in] string aPassword )
  58             raises( com::sun::star::lang::IllegalArgumentException );
  59
  60     //-------------------------------------------------------------------------
  61     /** @returns
  62                 the current state of protection.
  63      */
  64     boolean isProtected();
  65
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 #endif