com.businessobjects.sdk.plugin.desktop.customrole
Interface ICustomRoleBase

All Known Subinterfaces:

ICustomRole

public interface ICustomRoleBase

This interface represents a custom access level (custom role). Custom access levels are used to grant or deny permissions on objects to principals (users and user groups).

Field Summary

static java.lang.String	KIND The Kind used to query for CustomRole objects.
static java.lang.String	PROGID

Method Summary

java.util.Set	getAssignedObjects() Returns the IDs of the objects that are assigned to this custom role.
java.util.Set	getIntendedPluginKinds() Returns the plugins for which this custom role is intended.
IRoleRights	getRoleRights() Returns the rights associated with the custom role.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for CustomRole objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

getRoleRights

IRoleRights getRoleRights()

Returns the rights associated with the custom role.

Returns:

IRoleRights collection containing the rights associated with this role.

InfoObject properties to query for:

SI_ROLE_RIGHTS

getIntendedPluginKinds

java.util.Set getIntendedPluginKinds()

Returns the plugins for which this custom role is intended.

Returns:

A set containing the plugin kinds.

InfoObject properties to query for:

SI_INTENDED_PLUGINS

getAssignedObjects

java.util.Set getAssignedObjects()
                                 throws SDKException

Returns the IDs of the objects that are assigned to this custom role.

Returns:

A set containing the object IDs.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_OBJECTS_ASSIGNED_ROLE