udkapi/com/sun/star/security/XPolicy.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_security_XPolicy_idl__
  28 #define __com_sun_star_security_XPolicy_idl__
  29 #ifndef __com_sun_star_uno_XInterface_idl__
  30 #include <com/sun/star/uno/XInterface.idl>
  31 #endif
  32
  33
  34 module com {  module sun {  module star {  module security {
  35
  36 /** Interface for getting sets of permissions of a specified user or
  37     the default permissions if no user is given.
  38
  39     @see com::sun::star::security::Policy
  40
  41     @since OOo 1.1.2
  42 */
  43 published interface XPolicy : com::sun::star::uno::XInterface
  44 {
  45     /** Gets the permissions of the specified user excluding the default permissions
  46         granted to all users.
  47
  48         @param userId
  49                user id
  50         @return
  51                permissions of the specified user
  52     */
  53     sequence< any > getPermissions(
  54         [in] string userId );
  55
  56     /** Gets the default permissions granted to all users.
  57
  58         @return
  59                default permissions
  60     */
  61     sequence< any > getDefaultPermissions();
  62
  63     /** Refreshes the policy configuration.
  64     */
  65     void refresh();
  66 };
  67
  68 }; }; }; };
  69
  70 #endif