com.crystaldecisions.sdk.occa.infostore
Interface ISecurityLimit

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

public interface ISecurityLimit

This object provides information about the limits that are set on an object for a particular principal.

Method Summary

java.lang.String	getDescription(java.util.Locale locale) Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
int	getID() Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
int	getValue() Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
boolean	isInherited() Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
boolean	isMaximumValueUsed() Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
void	setInherited(boolean inherited) Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively
void	setValue(int lVal) Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

Method Detail

getID

int getID()

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

Returns the limit's ID.

Returns:

An int specifying the property ID.

setValue

void setValue(int lVal)

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

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()

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

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.

isMaximumValueUsed

boolean isMaximumValueUsed()

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

Returns true if the maximum value of the limit in the object inheritance is valid, and false if the minimum value is valid.

Returns:

true if the maximum value of the limit in the object inheritance is valid, and false if the minimum value is valid.

isInherited

boolean isInherited()

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

Returns true if the limit is inherited, and false otherwise.

Note: If the value is inherited, you can modify the value of the limit for the current object; however, the change will automatically change the value of this boolean to false.

Returns:

true if the limit is inherited, and false otherwise.

setInherited

void setInherited(boolean inherited)

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

Sets whether the limit is to be inherited. This value should be set to true if the limit is to be inherited, and false otherwise.

Note: If the value is inherited, you can modify the value of the limit for the current object; however, the change will automatically change the value of this boolean to false.

Parameters:

inherited - true if the limit is inherited, and false otherwise.

getDescription

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

Deprecated. Since 12.0, ISecurityLimit has been replaced by IExplicitLimit and IEffectiveLimit accessible through IExplicitLimits and IEffectiveLimits respectively

Returns the description of the limit.

Parameters:

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

Returns:

The localized description of the limit as a String.