com.crystaldecisions.sdk.occa.security
Interface ISecRightsQueryAdmin

All Known Subinterfaces:

ISecRightsAdmin

public interface ISecRightsQueryAdmin

The interface for rights query adminstration.

The methods defined here corresponds to administrative security queries through which a logged on user tries to query for admin security info from the server that require administrative rights from the user. 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 limitID, java.lang.Object rightKind, int principalID, int objectID) Checks the limit (long right) of a principal on a given object
int	checkRight(int rightID, java.lang.Object rightKind, int principalID, int objectID) Deprecated. since 12.0 SP1. Use checkRight(RightDescriptor right, int principalID, int objectID) instead
int	checkRight(RightDescriptor right, int principalID, int objectID) Checks the boolean right of a principal on a given object
ISecurityResult	getExplicitLimits(int objectID) Gets the explicit limits (long rights) associated with the object
ISecurityResult	getExplicitPrincipals(int objectID) Get list of principals that have explicit security info (rights, limits, roles) on the object
ISecurityResult	getExplicitRights(int objectID) Gets the explicit boolean rights associated with the object
ISecurityResult	getExplicitRoles(int objectID) Gets the explicit roles associated with the object
ISecurityResult	getKnownLimits(int objectID) Deprecated. This method returns a set of unique right IDs applicable to the given object, which do not contain plugin info and hide plugin override of a right description. Use getKnownRightsByPlugin instead.
ISecurityResult	getKnownRights(int objectID) Deprecated. This method returns a set of unique right IDs applicable to the given object, which do not contain plugin info and hide plugin override of a right description. Use getKnownRightsByPlugin instead.
ISecurityResult	getKnownRightsByPlugin(int objectID) Gets the known rights and limits of an object grouped by plugin types
ISecurityResult	getKnownRoles() Gets the list of known custom roles in the system
ISecurityResult	getPrincipals(int objectID) Gets the list of principals that have effective security info (rights, limits, roles) on the object
ISecurityResult	getSecurityInfo(int objectID) Gets the security info (all the effective principals, rights and roles) associated with the object
ISecurityResult	getSecurityInfo(int objectID, int principalID) Gets the security info (all the effective rights, limits and roles) associated with the object for a given principal

Method Detail

checkRight

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

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

Checks the boolean right of a principal on a given object

Parameters:

rightID - Right being accessed

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

principalID - Principal the right applies to

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 principalID,
               int objectID)
               throws SDKException

Checks the boolean right of a principal on a given object

Parameters:

right - Right being accessed

principalID - Principal the right applies to

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 limitID,
                           java.lang.Object rightKind,
                           int principalID,
                           int objectID)
                           throws SDKException

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

Parameters:

limitID - Limit being accessed

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

principalID - Principal the limit applies to

objectID - Object the limit applies to

Returns:

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

Throws:

SDKException

getExplicitRoles

ISecurityResult getExplicitRoles(int objectID)
                                 throws SDKException

Gets the explicit roles associated with the object

Parameters:

objectID - Object the role applies to

Returns:

ISecurityResult indicating the status of the security request and the returned result if the request is processed successfully. ISecurityResult.getResult returns an array of ISecurityRoleAdmin

Throws:

SDKException

getExplicitRights

ISecurityResult getExplicitRights(int objectID)
                                  throws SDKException

Gets the explicit boolean rights associated with the object

Parameters:

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.getResult returns an array of ISecurityRightAdmin

Throws:

SDKException

getExplicitLimits

ISecurityResult getExplicitLimits(int objectID)
                                  throws SDKException

Gets the explicit limits (long rights) associated with the object

Parameters:

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.getResult returns an array of ISecurityLimitAdmin

Throws:

SDKException

getSecurityInfo

ISecurityResult getSecurityInfo(int objectID)
                                throws SDKException

Gets the security info (all the effective principals, rights and roles) associated with the object

Parameters:

objectID - Object the security info applies to

Returns:

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

Throws:

SDKException

getSecurityInfo

ISecurityResult getSecurityInfo(int objectID,
                                int principalID)
                                throws SDKException

Gets the security info (all the effective rights, limits and roles) associated with the object for a given principal

Parameters:

objectID - Object the security info applies to

principalID - Principal the security info applies to

Returns:

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

Throws:

SDKException

getPrincipals

ISecurityResult getPrincipals(int objectID)
                              throws SDKException

Gets the list of principals that have effective security info (rights, limits, roles) on the object

Parameters:

objectID - Object whose principal list is retrieved

Returns:

ISecurityResult indicating the status of the security request and the returned result if the request is processed successfully. ISecurityResult.getResult returns an array of ISecurityPrincipal

Throws:

SDKException

getExplicitPrincipals

ISecurityResult getExplicitPrincipals(int objectID)
                                      throws SDKException

Get list of principals that have explicit security info (rights, limits, roles) on the object

Parameters:

objectID - Object whose principal list is retrieved

Returns:

ISecurityResult indicating the status of the security request and the returned result if the request is processed successfully. ISecurityResult.getResult returns an array of ISecurityPrincipal

Throws:

SDKException

getKnownRights

ISecurityResult getKnownRights(int objectID)
                               throws SDKException

Deprecated. This method returns a set of unique right IDs applicable to the given object, which do not contain plugin info and hide plugin override of a right description. Use getKnownRightsByPlugin instead.

Throws:

SDKException

getKnownLimits

ISecurityResult getKnownLimits(int objectID)
                               throws SDKException

Deprecated. This method returns a set of unique right IDs applicable to the given object, which do not contain plugin info and hide plugin override of a right description. Use getKnownRightsByPlugin instead.

Throws:

SDKException

getKnownRoles

ISecurityResult getKnownRoles()
                              throws SDKException

Gets the list of known custom roles in the system

Returns:

ISecurityResult indicating the status of the security request and the returned result if the request is processed successfully. ISecurityResult.getResult returns an array of IRoleID

Throws:

SDKException

getKnownRightsByPlugin

ISecurityResult getKnownRightsByPlugin(int objectID)
                                       throws SDKException

Gets the known rights and limits of an object grouped by plugin types

Parameters:

objectID - Object ID

Returns:

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

Throws:

SDKException