xref: /aoo41x/main/offapi/com/sun/star/sdbcx/XAuthorizable.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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