summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdbcx/XAuthorizable.idl
blob: fae08415857a12c815f4572fb20e744eec04861a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_sdbcx_XAuthorizable_idl__
#define __com_sun_star_sdbcx_XAuthorizable_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/sdbc/SQLException.idl>

 module com {  module sun {  module star {  module sdbcx {

/** is used for accessing and setting the permissions of a user for a database
    object.
    @see com::sun::star::sdbcx::PrivilegeObject
    @see com::sun::star::sdbcx::Privilege
 */
published interface XAuthorizable: com::sun::star::uno::XInterface
{

    /** retrieves the permissions for a specific object.

        @param objName
            the name of the object
        @param objType
            a value of com::sun::star::sdbcx::PrivilegeObject

        @returns
            the privileges

        @throws com::sun::star::sdbc::SQLException
                if a database access error occurs.
     */
    long getPrivileges([in]string objName, [in]long objType) raises
                        (com::sun::star::sdbc::SQLException);

    /** retrieves the permissions for a specific object, which could be granted
        to other users and groups.

        @param objName
            the name of the object
        @param objType
            a value of com::sun::star::sdbcx::PrivilegeObject

        @returns
            the grant privileges

        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    long getGrantablePrivileges([in]string objName, [in]long objType) raises
                        (com::sun::star::sdbc::SQLException);

    /** adds additional permissions for a specific object.

        @param objName
            the name of the object
        @param objType
            a value from the com::sun::star::sdbcx::PrivilegeObject constants group
        @param objPrivileges
            a value from the com::sun::star::sdbcx::Privilege constants group

        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    void grantPrivileges([in]string objName, [in]long objType,
                         [in]long objPrivileges) raises
        (com::sun::star::sdbc::SQLException);

    /** removes permissions for a specific object from a group or user.

        @param objName
            the name of the object
        @param objType
            a value from the com::sun::star::sdbcx::PrivilegeObject constants group
        @param objPrivileges
            a value from the com::sun::star::sdbcx::Privilege constants group


        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    void revokePrivileges([in]string objName, [in]long objType,
                          [in]long objPrivileges) raises
        (com::sun::star::sdbc::SQLException);
};


}; }; }; };

/*===========================================================================
===========================================================================*/
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */