com.crystaldecisions.sdk.occa.infostore
Interface IExplicitRoles

public interface IExplicitRoles

This interface represents a collection of custom access levels (custom roles) assigned to an object for a particular principal (user or group). A custom access level contains a collection of rights. When a custom access level is assigned to a principal on an object, all the rights assigned to it are included during the calculation of the effective rights for the principal on the object.

Method Summary

IExplicitRole	add(int id) Adds a new custom access level to the collection.
IExplicitRole	get(int id) Returns the custom access level with the given ID.
java.util.Iterator	iterator() Returns an iterator for all of the custom access levels in the collection.
void	remove(int id) Removes a custom access level from the collection.
int	size() Returns the size of the custom access levels collection, excluding deleted values.

Method Detail

add

IExplicitRole add(int id)
                  throws SDKException

Adds a new custom access level to the collection.

Parameters:

id - The ID of the new custom access level to be added.

Returns:

The newly created IExplicitRole object.

Throws:

SDKException

remove

void remove(int id)
            throws SDKException

Removes a custom access level from the collection.

Parameters:

id - The ID of the custom access level to be removed.

Throws:

SDKException

get

IExplicitRole get(int id)

Returns the custom access level with the given ID.

Parameters:

id - The ID of the custom access level to be returned.

Returns:

The custom access level, or null if no such custom access level exists.

iterator

java.util.Iterator iterator()

Returns an iterator for all of the custom access levels in the collection.

Returns:

An iterator for all of the custom access levels in the collection.

size

int size()

Returns the size of the custom access levels collection, excluding deleted values.

Returns:

the number of the custom access levels.