summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbcx/XAuthorizable.idl
blob: 605b25177ee0abf43197a4eb746d81027c1a12c9 (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
111
112
113
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XAuthorizable.idl,v $
 * $Revision: 1.11 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbcx_XAuthorizable_idl__
#define __com_sun_star_sdbcx_XAuthorizable_idl__

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

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

 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
 */
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
            <type scope="com::sun::star::sdbcx">PrivilegeObject</Type>
        @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
            <type scope="com::sun::star::sdbcx">PrivilegeObject</Type>
        @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 <type scope="com::sun::star::sdbcx">PrivilegeObject</type> 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 <type scope="com::sun::star::sdbcx">PrivilegeObject</type> 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