com.crystaldecisions.sdk.occa.infostore
Interface IEffectiveLimit

All Superinterfaces:

IRightIDBase

All Known Subinterfaces:

ISecurityLimitAdmin

public interface IEffectiveLimit
extends IRightIDBase

This object provides information about an effective limit that a particular principal has on an object. The effective limit is determined by first checking for an explicit limit for the principal on the object. If an explicit limit exists on the object, then the effective limit is equal to the explicit limit. if an explicit limit does not exist, then the ancestor objects are checked recursively until an explicit limit for the principal is found.

Method Summary

java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of the security item.
RightIDDescriptor	getLimitID() Returns the description used to identify the limit.
int	getValue() Returns the numeric value of the limit.

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IRightIDBase

getBaseID, getID, getRightPluginKind, getRightPluginType, isOwner

Method Detail

getDescription

java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of the security item.

Parameters:

locale - A Locale object specifying the locale-specific display properties.

Returns:

The localized description of the security item as a String.

getValue

int getValue()

Returns the numeric value of the limit. For example, on a report object, a user might have a limit on the number of instances they are allowed to have. This method would be used to get the maximum number of instances the user is allowed to have.

Returns:

An int representing the numeric value of the limit.

getLimitID

RightIDDescriptor getLimitID()

Returns the description used to identify the limit.

Returns:

An int representing the limit identifier.