com.crystaldecisions.sdk.occa.security
Interface ISecRights

public interface ISecRights

The interface for checking non-admin rights.

The methods defined here corresponds to non-administrative security queries through which a logged on user tries to query for its own security info from the server. Use ISecCacheController to query and cache the security info first then use this interface to retrieve the result from the cached information. Without caching the query result through ISecCacheController first or retrieving after the cached result has expired will result in round trip queries to the server for each query. The default interval for cache age is 1 minute.

Method Summary

ISecurityResult	checkLimit(int rightID, java.lang.Object rightKind, int objectID) Checks the limit (long right) of a principal on a given object
int	checkRight(int rightID, java.lang.Object rightKind, int objectID) Deprecated. since 12.0 SP1. Use checkRight(RightDescriptor right, int objectID) instead
int	checkRight(RightDescriptor right, int objectID) Checks the boolean right of a principal on a given object

Method Detail

checkRight

int checkRight(int rightID,
               java.lang.Object rightKind,
               int objectID)
               throws SDKException

Deprecated. since 12.0 SP1. Use checkRight(RightDescriptor right, int objectID) instead

Checks the boolean right of a principal on a given object

Parameters:

rightID - ID of the right being accessed

rightKind - Plugin kind the right is defined for. Can be the integer object type or the object kind string.

objectID - Object the right applies to

Returns:

Status code as defined in ISecurityResult indicating the status of the security request

Throws:

SDKException

checkRight

int checkRight(RightDescriptor right,
               int objectID)
               throws SDKException

Checks the boolean right of a principal on a given object

Parameters:

right - right being accessed

objectID - Object the right applies to

Returns:

Status code as defined in ISecurityResult indicating the status of the security request

Throws:

SDKException

checkLimit

ISecurityResult checkLimit(int rightID,
                           java.lang.Object rightKind,
                           int objectID)
                           throws SDKException

Checks the limit (long right) of a principal on a given object

Parameters:

rightID - ID of the limit being accessed

rightKind - Plugin kind the right is defined for. Can be the integer object type or the object kind string.

objectID - Object the right applies to

Returns:

ISecurityResult indicating the status of the security request and the returned result if the request is processed successfully. ISecurityResult.getValue returns ILimitResult

Throws:

SDKException