summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbcx/XAuthorizable.idl
blob: c9ba47ea424ef2581a98ccafe7613d9afec08214 (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*************************************************************************
 *
 *  $RCSfile: XAuthorizable.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:07:20 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#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 {

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

    // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::getPrivileges
    /** 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);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::getGrantablePrivileges
    /** 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);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::grantPrivileges
    /** adds additional 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>
        @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);
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::sdbcx::XAuthorizable::revokePrivileges
    /** removes permissions for a specific object from a group or user.
        @param objName
            the name of the object
        @param objType
            a value of
            <type scope="com::sun::star::sdbcx">PrivilegeObject</Type>
        @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);
};

//=============================================================================

}; }; }; };

/*===========================================================================
    $Log: not supported by cvs2svn $
    Revision 1.4.16.1  2002/02/18 10:00:22  oj
    #97563# parameter,return value and exception description

    Revision 1.4  2001/03/16 16:41:36  jsc
    remove interfaceheader with uik and remove [const] in method definitions

    Revision 1.3  2000/11/08 12:43:40  mi
    moved from api

    Revision 1.1.1.1  2000/09/18 23:35:45  hjs
    initial import

    Revision 1.4  2000/09/11 11:52:45  mi
    documentation merged from XML

    Revision 1.2  1999/12/20 16:26:15  dg
    #70278# new package name

    Revision 1.1  1999/11/24 08:42:09  dg
    new StarDataDefinitionBeans

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