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

All Superinterfaces:

java.util.Collection, ISDKSet, java.lang.Iterable, java.util.Set

public interface IRoleRights
extends ISDKSet

This interface defines the collection of rights associated with a custom access level (custom role) object.

Use this interface to add, remove, and modify the role rights included in this custom role.

Method Summary

IRoleRight	addRoleRight(RightDescriptor right, boolean granted) Adds a role right to the collection.
IRoleRight	getRoleRight(RightDescriptor right) Returns the specified role right from the collection.
boolean	removeRoleRight(RightDescriptor right) Removes the specified role right from the collection.

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKSet

get

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

addRoleRight

IRoleRight addRoleRight(RightDescriptor right,
                        boolean granted)
                        throws SDKException

Adds a role right to the collection.

Parameters:

right - Right descriptor that defines the role right

granted - true to grant permission or false to deny permission

Returns:

The role right.

Throws:

SDKException.DuplicateEntry - if the right already exists in the collection.

SDKException

getRoleRight

IRoleRight getRoleRight(RightDescriptor right)
                        throws SDKException

Returns the specified role right from the collection.

Parameters:

right - Right descriptor that identifies the role right

Returns:

The role right in the collection that matches the input right descriptor or null if no match is found.

Throws:

SDKException - if the process is unsuccessful.

removeRoleRight

boolean removeRoleRight(RightDescriptor right)
                        throws SDKException

Removes the specified role right from the collection.

Parameters:

right - Right descriptor that identifies the role right

Returns:

true if the role right is successfully removed from the collection or false if the role right was not found.

Throws:

SDKException