com.crystaldecisions.sdk.occa.infostore
Interface IEffectiveRight

All Superinterfaces:

IRightBase, IRightIDBase

All Known Subinterfaces:

ISecurityRightAdmin

public interface IEffectiveRight
extends IRightBase

This object provides information about an effective right on an object for a particular principal. An effective right is calculated based on the rights explicitly assigned on the object and its parents objects, and is therefore read-only.

Method Summary

java.util.List	getImplicitSources() Returns the hypothetical set of sources from which the security item is effectively inherited if the right was not explicitly assigned to the current object.
java.util.List	getSources() Returns the set of sources from which the security item is effectively inherited If an effective right is the result of an explicit right set on the Info Object, the sources will contain an entry that refers to the current object and the current principal
boolean	isImplicitGranted() Returns whether the right is granted without taking into account the explicit rights assigned to current object.
boolean	isInherited() Returns whether the right is inherited from a parent object or a parent group.

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IRightBase

getApplicableKind, getApplicableType, getDescription, getObjectType, getRightDescriptor, getScope, isGranted, isSpecified

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IRightIDBase

getBaseID, getID, getRightPluginKind, getRightPluginType, isOwner

Method Detail

getSources

java.util.List getSources()

Returns the set of sources from which the security item is effectively inherited If an effective right is the result of an explicit right set on the Info Object, the sources will contain an entry that refers to the current object and the current principal

Returns:

the set of sources from which the right is effectively inherited. Each element is of type IRightSource

getImplicitSources

java.util.List getImplicitSources()

Returns the hypothetical set of sources from which the security item is effectively inherited if the right was not explicitly assigned to the current object. See IEffectiveRight.isImplicitGranted() for more detail. When the set is empty, that means the right was not specified in any parent groups or folders, and is the result of the currently set explicit right.

Returns:

the hypothetical set of sources from which the right is effectively inherited if the right was not explicitly assigned to the current object. Each element is of type IRightSource.

isImplicitGranted

boolean isImplicitGranted()

Returns whether the right is granted without taking into account the explicit rights assigned to current object. This is useful for determining what the effective value for the current right would be if the corresponding explicit right assigned to current principal on current object is removed. The value will be exactly the same as the return value of IRightBase.isGranted() if the corresponding explicit right is not assigned to current principal on the object.

Returns:

true if the right is granted without taking into account the explicit rights assigned to current object, and false otherwise.

isInherited

boolean isInherited()

Returns whether the right is inherited from a parent object or a parent group.

Returns:

true if the right is inherited from a parent object or a parent group.