com.crystaldecisions.sdk.occa.infostore
Interface IExplicitLimits

public interface IExplicitLimits

This interface represents a collection that contains the limits that are explicitly assigned on an object for a particular principal (user or group). These limits allow report instances to be deleted on a regular basis. Limits that you set on a folder affect all objects that are contained within the folder. At the folder level, you may want to limit the number of instances that remain on the system for each object or for each user or group; you could also limit the number of days that an instance remains on the system for a user or group.

In addition to setting limits on folders, you can set limits on selected report objects and their instances. When you set the limits at the report object level, the report object will ignore the limits set for the folder (that is, the report object will not inherit the limits of the folder).

Method Summary

IExplicitLimit	add(RightDescriptor limit) Adds a new limit to the collection.
IExplicitLimit	get(RightDescriptor request) Returns the limit that matches the given limit description.
java.util.Iterator	iterator() Returns an iterator for all of the limits in the collection.
void	remove(RightDescriptor limit) Removes a limit from the collection.
int	size() Returns the number of the limits in this collection.

Method Detail

get

IExplicitLimit get(RightDescriptor request)

Returns the limit that matches the given limit description.

Parameters:

request - Definition for the requested limit

Returns:

The limit, or null if no such limit exists.

iterator

java.util.Iterator iterator()

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

Returns:

An iterator for all of the limits in the collection.

size

int size()

Returns the number of the limits in this collection.

Returns:

the size of the limits collection.

add

IExplicitLimit add(RightDescriptor limit)
                   throws SDKException

Adds a new limit to the collection.

Parameters:

limit - The definition of the new limit to be added.

Returns:

The newly created IExplicitLimit object.

Throws:

SDKException

remove

void remove(RightDescriptor limit)
            throws SDKException

Removes a limit from the collection.

Parameters:

limit - The definition of the limit to be removed.

Throws:

SDKException