com.crystaldecisions.sdk.occa.infostore
Interface IEffectiveLimits

public interface IEffectiveLimits

This collection contains the effective limits on an object for a particular principal (user, 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

IEffectiveLimit	get(RightIDDescriptor right) Returns the limit that matches the given limit description.
java.util.Iterator	iterator() Returns an iterator for all of the limits in the collection.
int	size() Returns the size of the limits in this collection.

Method Detail

get

IEffectiveLimit get(RightIDDescriptor right)

Returns the limit that matches the given limit description.

Parameters:

right - The description of the limit to be returned.

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 size of the limits in this collection.

Returns:

the size of the limits((excluding deleted values)