com.crystaldecisions.sdk.occa.infostore
Interface IEffectiveRights

public interface IEffectiveRights

This interface represents a collection of effective granular rights on an object for a particular principal (user or group). The SAP BusinessObjects Enterprise system defines a set of base rights that can be applied to different types of objects in the system. For example, the "View objects" right is a base right: it applies equally well to folders, to reports, and to other SAP BusinessObjects Enterprise objects. Some base rights, however, can be applied to only some types of objects. For example, the "Schedule instances" right is a base right that can only be applied to schedulable objects such as Crystal Reports, Webi, etc. or objects that contain these objects. In addition to these base rights, each type of object provides an additional set of rights that apply only to that object type. For example, the "Refresh the report's data" right applies only to report objects. We call these rights plugin specific rights.

The Central Management Server (CMS) is the component that keeps track of known or available rights. The list of available rights includes the base rights and all other plugin specific rights that have been provided by particular object types, such as Crystal report objects.

For the purposes of inheritance, you may want to select a number of available rights and add them to the object's IExplicitRights collection, even if they don't apply directly to that object. By doing this, you can set object security at the folder level (rather than repeating the same settings for every object in the folder). Although certain object-specific rights do not strictly apply to the folder object itself, these rights may apply to objects that inherit rights from the folder. In other words, if you add the "Refresh the report's data" right to a folder object's IExplicitRights collection with "descendants" scope, you are granting a principal the right to refresh the data in all reports that are contained in this folder.

Method Summary

IEffectiveRight	get(RightDescriptor right) Returns the read-only right that matches the given right description.
java.util.Iterator	iterator() Returns an iterator for all of the rights in the collection.
int	size() Returns the size of the rights in this collection.

Method Detail

get

IEffectiveRight get(RightDescriptor right)

Returns the read-only right that matches the given right description.

Parameters:

right - The description of the right being requested.

Returns:

The read-only right, or null if no such right exists.

iterator

java.util.Iterator iterator()

Returns an iterator for all of the rights in the collection.

Returns:

An iterator for all of the rights in the collection.

size

int size()

Returns the size of the rights in this collection.

Returns:

the size of the rights