com.crystaldecisions.sdk.occa.infostore
Interface IExplicitLimit

All Superinterfaces:

IRightIDBase

All Known Subinterfaces:

ISecurityLimitAdmin

public interface IExplicitLimit
extends IRightIDBase

This object provides information about a limit that is assigned to an object for a particular principal.

Method Summary

java.lang.String	getApplicableKind() Returns plugin kind the security item applies to.
java.lang.String	getDescription(java.util.Locale locale) Returns the description of the security item.
RightDescriptor	getLimitDescriptor() Returns the description used to identify the limit.
java.lang.String	getObjectType() Deprecated. As of version 12.0. Use IExplicitLimit.getApplicableKind() instead, which has the same meaning but a more intuitive API name.
java.lang.String	getScope() Returns the scope of the security item.
int	getValue() Gets the numeric value of the limit.
void	setValue(int lVal) Sets 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 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.

getObjectType

java.lang.String getObjectType()

Deprecated. As of version 12.0. Use IExplicitLimit.getApplicableKind() instead, which has the same meaning but a more intuitive API name.

getApplicableKind

java.lang.String getApplicableKind()

Returns plugin kind the security item applies to. When the applicable kind of a limit is set to a particular plugin kind, this limit is only applicable to the type of objects corresponding to this plugin kind.

Returns:

the specific object type to which the security item applies.

getScope

java.lang.String getScope()

Returns the scope of the security item. The value is defined in CeSecurityOptions.RightScope. The scope can be "this" or "descendants". "this" means that the assigned limit is effective on the current object and "descendants" means it is effective on objects contained in the current object.

Returns:

The scope of the security item.

setValue

void setValue(int lVal)

Sets 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 set the maximum number of instances the user is allowed to have.

Parameters:

lVal - The numeric int value to be set.

getValue

int getValue()

Gets 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 IntegerRight.

getLimitDescriptor

RightDescriptor getLimitDescriptor()

Returns the description used to identify the limit.

Returns:

The limit descriptor.