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