com.crystaldecisions.sdk.occa.infostore
Interface ISecurityLimits


public interface ISecurityLimits

Use this collection to set 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
 ISecurityLimit add(int id)
           Adds a new limit to the collection.
 ISecurityLimit get(int id)
           Returns the limit with the given ID.
 java.util.Iterator iterator()
           Returns an iterator for all of the limits in the set.
 void remove(int id)
           Removes a limit from the collection.
 int size()
           Returns the size of the limits in the collection.
 

Method Detail

add

public ISecurityLimit add(int id)

Adds a new limit to the collection.

Note: If you add multiple limits that have the same ID but that contain different values to the collection; the most recent value of the limit overwrites the older value.

Parameters:
id - The ID of the new limit.
Returns:
The newly created ISecurityLimit object.

get

public ISecurityLimit get(int id)

Returns the limit with the given ID.

Parameters:
id - The ID of the limit to be returned.
Returns:
The limit, or null if no such limit exists,

iterator

public java.util.Iterator iterator()

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

Returns:
An iterator for all of the limits in the set.

remove

public void remove(int id)

Removes a limit from the collection.

Parameters:
id - The ID of the limit to remove.

size

public int size()

Returns the size of the limits in the collection.

Returns:
size of the limits(excluding deleted values).