com.crystaldecisions.sdk.occa.security
Interface ISecRightsAdmin

All Superinterfaces:

IBatch, ISecRightsQueryAdmin

public interface ISecRightsAdmin
extends ISecRightsQueryAdmin, IBatch

The interface for checking non-admin rights. Extends IBatch to allow for batched modification operations.

The methods defined here corresponds to administrative security requests through which a logged on user tries to modify certain security content that only users with adiministrative rights are allowed to perform.

Method Summary

int	removeLimit(RightDescriptor limit, int principalID, int objectID) Removes a limit
int	removeLimits(int principalID, int objectID) Removes all the limits associated with a principal on an object
int	removeRight(RightDescriptor right, int principalID, int objectID) Removes a right
int	removeRights(int principalID, int objectID) Removes all the rights associated with a principal on an object
int	removeRole(int roleID, int principalID, int objectID) Removes a role
int	removeRoles(int principalID, int objectID) Removes all the roles associated with a principal on an object
int	setGlobalFolderInheritance(int objectID, boolean inherit) Sets the global folder inheritance for the given object, so that when the inheritance is turned off, no principal should have folder inheritance on the object.
int	setInheritFoldersForPrincipal(int objectID, int principalID, boolean inherit) Sets whether the principal can inherit security info from an object's parents
int	setInheritGroupsForPrincipal(int objectID, int principalID, boolean inherit) Sets whether the principal can inherit security info from its group principals
int	setLimit(RightDescriptor limit, int principalID, int objectID, int Value) Sets a limit
int	setRight(RightDescriptor right, int principalID, int objectID, boolean Value) Sets a boolean right
int	setRole(int roleID, int principalID, int objectID) Sets a role

Methods inherited from interface com.crystaldecisions.sdk.occa.security.ISecRightsQueryAdmin

checkLimit, checkRight, checkRight, getExplicitLimits, getExplicitPrincipals, getExplicitRights, getExplicitRoles, getKnownLimits, getKnownRights, getKnownRightsByPlugin, getKnownRoles, getPrincipals, getSecurityInfo, getSecurityInfo

Methods inherited from interface com.crystaldecisions.sdk.occa.security.IBatch

batch, batch, batch, commit, rollback

Method Detail

removeRight

int removeRight(RightDescriptor right,
                int principalID,
                int objectID)
                throws SDKException

Removes a right

Parameters:

right - RightDescriptor structure that defines a right being removed

principalID - Principal the right is assigned to

objectID - Object the right applies to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

removeLimit

int removeLimit(RightDescriptor limit,
                int principalID,
                int objectID)
                throws SDKException

Removes a limit

Parameters:

limit - RightDescriptor structure that defines a limit being removed

principalID - Principal the limit is assigned to

objectID - Object the limit applies to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

removeRights

int removeRights(int principalID,
                 int objectID)
                 throws SDKException

Removes all the rights associated with a principal on an object

Parameters:

principalID - Principal whose rights are to be removed

objectID - Object the rights apply to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

removeLimits

int removeLimits(int principalID,
                 int objectID)
                 throws SDKException

Removes all the limits associated with a principal on an object

Parameters:

principalID - Principal whose limits are to be removed

objectID - Object the limits apply to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

removeRoles

int removeRoles(int principalID,
                int objectID)
                throws SDKException

Removes all the roles associated with a principal on an object

Parameters:

principalID - Principal whose roles are to be removed

objectID - Object the roles apply to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

removeRole

int removeRole(int roleID,
               int principalID,
               int objectID)
               throws SDKException

Removes a role

Parameters:

roleID - Role being removed

principalID - Principal the role applies to on the object

objectID - Object the right applies to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

setRight

int setRight(RightDescriptor right,
             int principalID,
             int objectID,
             boolean Value)
             throws SDKException

Sets a boolean right

Parameters:

right - RightDescriptor structure that defines a right being set

principalID - Principal the right is assigned to

objectID - Object the right applies to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

setLimit

int setLimit(RightDescriptor limit,
             int principalID,
             int objectID,
             int Value)
             throws SDKException

Sets a limit

Parameters:

limit - RightDescriptor structure that defines a limit being set

principalID - Principal the limit is assigned to

objectID - Object the limit applies to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

setRole

int setRole(int roleID,
            int principalID,
            int objectID)
            throws SDKException

Sets a role

Parameters:

roleID - Role being set

principalID - Principal the right applies to on the object

objectID - Object the right applies to

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

setInheritFoldersForPrincipal

int setInheritFoldersForPrincipal(int objectID,
                                  int principalID,
                                  boolean inherit)
                                  throws SDKException

Sets whether the principal can inherit security info from an object's parents

Parameters:

objectID - Integer ID of an object

principalID - Integer ID of a principal

inherit - Value of inheritance. True if principal inherits from parent objects, false otherwise

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

setInheritGroupsForPrincipal

int setInheritGroupsForPrincipal(int objectID,
                                 int principalID,
                                 boolean inherit)
                                 throws SDKException

Sets whether the principal can inherit security info from its group principals

Parameters:

objectID - Integer ID of an object

principalID - Integer ID of a principal

inherit - Value of inheritance. True if principal inherits from parent groups, false otherwise

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException

setGlobalFolderInheritance

int setGlobalFolderInheritance(int objectID,
                               boolean inherit)
                               throws SDKException

Sets the global folder inheritance for the given object, so that when the inheritance is turned off, no principal should have folder inheritance on the object. This flag, when set to false, overrides the folder inheritance set on individual principals on the same object

Parameters:

objectID - Integer ID of an object

inherit - Value of inheritance. True if principal inherits from parent objects, false otherwise

Returns:

Status code in ISecurityResult indicating the status of the security request

Throws:

SDKException