offapi/com/sun/star/sdbcx/XAuthorizable.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
  20  module com {  module sun {  module star {  module sdbcx {
  21
  22 /** is used for accessing and setting the permissions of a user for a database
  23     object.
  24     @see com::sun::star::sdbcx::PrivilegeObject
  25     @see com::sun::star::sdbcx::Privilege
  26  */
  27 published interface XAuthorizable: com::sun::star::uno::XInterface
  28 {
  29
  30     /** retrieves the permissions for a specific object.
  31
  32         @param objName
  33             the name of the object
  34         @param objType
  35             a value of com::sun::star::sdbcx::PrivilegeObject
  36
  37         @returns
  38             the privileges
  39
  40         @throws com::sun::star::sdbc::SQLException
  41                 if a database access error occurs.
  42      */
  43     long getPrivileges([in]string objName, [in]long objType) raises
  44                         (com::sun::star::sdbc::SQLException);
  45
  46     /** retrieves the permissions for a specific object, which could be granted
  47         to other users and groups.
  48
  49         @param objName
  50             the name of the object
  51         @param objType
  52             a value of com::sun::star::sdbcx::PrivilegeObject
  53
  54         @returns
  55             the grant privileges
  56
  57         @throws com::sun::star::sdbc::SQLException
  58             if a database access error occurs.
  59      */
  60     long getGrantablePrivileges([in]string objName, [in]long objType) raises
  61                         (com::sun::star::sdbc::SQLException);
  62
  63     /** adds additional permissions for a specific object.
  64
  65         @param objName
  66             the name of the object
  67         @param objType
  68             a value from the com::sun::star::sdbcx::PrivilegeObject constants group
  69         @param objPrivileges
  70             a value from the com::sun::star::sdbcx::Privilege constants group
  71
  72         @throws com::sun::star::sdbc::SQLException
  73             if a database access error occurs.
  74      */
  75     void grantPrivileges([in]string objName, [in]long objType,
  76                          [in]long objPrivileges) raises
  77         (com::sun::star::sdbc::SQLException);
  78
  79     /** removes permissions for a specific object from a group or user.
  80
  81         @param objName
  82             the name of the object
  83         @param objType
  84             a value from the com::sun::star::sdbcx::PrivilegeObject constants group
  85         @param objPrivileges
  86             a value from the com::sun::star::sdbcx::Privilege constants group
  87
  88
  89         @throws com::sun::star::sdbc::SQLException
  90             if a database access error occurs.
  91      */
  92     void revokePrivileges([in]string objName, [in]long objType,
  93                           [in]long objPrivileges) raises
  94         (com::sun::star::sdbc::SQLException);
  95 };
  96
  97
  98 }; }; }; };
  99
 100 /*===========================================================================
 101 ===========================================================================*/
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */