xref: /trunk/main/udkapi/com/sun/star/security/XPolicy.idl (revision 95a17a32)
1408a4873SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4408a4873SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5408a4873SAndrew Rist * distributed with this work for additional information
6408a4873SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the
8408a4873SAndrew Rist * "License"); you may not use this file except in compliance
9408a4873SAndrew Rist * with the License.  You may obtain a copy of the License at
10408a4873SAndrew Rist *
11408a4873SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12408a4873SAndrew Rist *
13408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing,
14408a4873SAndrew Rist * software distributed under the License is distributed on an
15408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16408a4873SAndrew Rist * KIND, either express or implied.  See the License for the
17408a4873SAndrew Rist * specific language governing permissions and limitations
18408a4873SAndrew Rist * under the License.
19408a4873SAndrew Rist *
20408a4873SAndrew Rist *************************************************************/
21408a4873SAndrew Rist
22408a4873SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_security_XPolicy_idl__
24cdf0e10cSrcweir#define __com_sun_star_security_XPolicy_idl__
25cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
26cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
27cdf0e10cSrcweir#endif
28cdf0e10cSrcweir
29cdf0e10cSrcweir
30cdf0e10cSrcweirmodule com {  module sun {  module star {  module security {
31cdf0e10cSrcweir
32cdf0e10cSrcweir/** Interface for getting sets of permissions of a specified user or
33cdf0e10cSrcweir    the default permissions if no user is given.
34cdf0e10cSrcweir
35cdf0e10cSrcweir    @see com::sun::star::security::Policy
36cdf0e10cSrcweir
37*95a17a32SJürgen Schmidt    @since OpenOffice 1.1.2
38cdf0e10cSrcweir*/
39cdf0e10cSrcweirpublished interface XPolicy : com::sun::star::uno::XInterface
40cdf0e10cSrcweir{
41cdf0e10cSrcweir    /** Gets the permissions of the specified user excluding the default permissions
42cdf0e10cSrcweir        granted to all users.
43cdf0e10cSrcweir
44cdf0e10cSrcweir        @param userId
45cdf0e10cSrcweir               user id
46cdf0e10cSrcweir        @return
47cdf0e10cSrcweir               permissions of the specified user
48cdf0e10cSrcweir    */
49cdf0e10cSrcweir    sequence< any > getPermissions(
50cdf0e10cSrcweir        [in] string userId );
51cdf0e10cSrcweir
52cdf0e10cSrcweir    /** Gets the default permissions granted to all users.
53cdf0e10cSrcweir
54cdf0e10cSrcweir        @return
55cdf0e10cSrcweir               default permissions
56cdf0e10cSrcweir    */
57cdf0e10cSrcweir    sequence< any > getDefaultPermissions();
58cdf0e10cSrcweir
59cdf0e10cSrcweir    /** Refreshes the policy configuration.
60cdf0e10cSrcweir    */
61cdf0e10cSrcweir    void refresh();
62cdf0e10cSrcweir};
63cdf0e10cSrcweir
64cdf0e10cSrcweir}; }; }; };
65cdf0e10cSrcweir
66cdf0e10cSrcweir#endif
67