com.crystaldecisions.sdk.occa.security
Interface ISecurityInfoMgr


public interface ISecurityInfoMgr

This object manages the security content the logged on user has access to. Through this interface, the logged on user can check/modify the security information related to objects and principals of interest.


Method Summary
 ISecRights getRights()
          

Obtain an interface on the Rights object.

 ISecRightsAdmin getRightsAdmin()
          

Obtain an admin interface on the Rights object.

 ISecCacheController getSecCache()
          

Obtain an interface on the security cache controller.

 ISecCacheControllerAdmin getSecCacheAdmin()
          

Obtain an admin interface on the security cache controller.

 

Method Detail

getSecCache

ISecCacheController getSecCache()
                                throws SDKException

Obtain an interface on the security cache controller. Use this to batch together non-admin security query requests and send to the CMS. The result will be cached for later retrieval through getRights().

Throws:
SDKException

getSecCacheAdmin

ISecCacheControllerAdmin getSecCacheAdmin()
                                          throws SDKException

Obtain an admin interface on the security cache controller. Use this to batch together admin security query requests and send to the CMS. The result will be cached for later retrieval through getRightsAdmin().

Admin requests are those associated with security information that only users with administrative rights have access to.

Throws:
SDKException

getRights

ISecRights getRights()
                     throws SDKException

Obtain an interface on the Rights object. Use this to retrieve the query result cached by previous calling to getSecCache(). The method called without querying through getSecCache() first, or after the cached result has expired (default is 1 minute) will result in a roundtrip to the CMS for each query request.

Throws:
SDKException

getRightsAdmin

ISecRightsAdmin getRightsAdmin()
                               throws SDKException

Obtain an admin interface on the Rights object. Use this to retrieve the query result cached by previous calling to getSecCacheAdmin(). The method called without querying through getSecCacheAdmin() first, or after the cached result has expired (default is 1 minute) will result in a roundtrip to the CMS for each query request. Another use of this is to batch together security modification commands to be committed to the CMS.

Admin requests are those associated with security information that only users with administrative rights have access to.

Throws:
SDKException