com.crystaldecisions.sdk.occa.infostore
Interface ISecurityLimit


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)
           Returns the description of the limit.
 int getID()
           Returns the limit's ID.
 int getValue()
           Gets the numeric value of the limit.
 boolean isInherited()
           Returns true if the limit is inherited, and false otherwise.
 boolean isMaximumValueUsed()
           Returns true if the maximum value of the limit in the object inheritance is valid, and false if the minimum value is valid.
 void setInherited(boolean inherited)
           Sets whether the limit is to be inherited.
 void setValue(int lVal)
           Sets the numeric value of the limit.
 

Method Detail

getID

public int getID()

Returns the limit's ID.

Returns:
An int specifying the property ID.

setValue

public 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

public 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.

isMaximumValueUsed

public boolean isMaximumValueUsed()

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

public boolean isInherited()

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

public void setInherited(boolean inherited)

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

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

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.