com.crystaldecisions.sdk.occa.infostore
Interface IEffectivePrincipal

All Superinterfaces:
IPrincipalBase

public interface IEffectivePrincipal
extends IPrincipalBase

This interface defines the object principal (a user or a group) with effective rights to a particular object. An effective principal is calculated and is therefore read-only.


Method Summary
 IEffectiveLimits getLimits()
           Returns a collection of limits that are effective to the principal on an Info Object.
 IEffectiveRights getRights()
           Returns a collection of rights that are effective to the principal on an Info Object.
 IEffectiveRoles getRoles()
           Returns a collection of roles that are effective to the principal on an Info Object.
 boolean isAdvanced()
           Returns true if this principal effectively has any granular rights set that are not from a role definition.
 boolean isInherited()
           Returns true if all of this principal's rights are effectively inherited from parent objects or parent groups.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IPrincipalBase
getID, getName, isInheritFolders, isInheritGroups
 

Method Detail

getRights

IEffectiveRights getRights()

Returns a collection of rights that are effective to the principal on an Info Object. This may be different from the explicit rights.

Returns:
An IEffectiveRights object that contains the rights effective to the principal on an Info Object.

getLimits

IEffectiveLimits getLimits()

Returns a collection of limits that are effective to the principal on an Info Object.

Returns:
An IEffectiveLimits object that contains the limits effective to the principal on an Info Object.

getRoles

IEffectiveRoles getRoles()

Returns a collection of roles that are effective to the principal on an Info Object.

Returns:
An IEffectiveRoles object that contains the roles effective to the principal on an Info Object.

isAdvanced

boolean isAdvanced()

Returns true if this principal effectively has any granular rights set that are not from a role definition.

Returns:
true if this principal effectively has any granular rights set that are not from a role definition.

isInherited

boolean isInherited()

Returns true if all of this principal's rights are effectively inherited from parent objects or parent groups.

Returns:
true if all of this principal's rights are effectively inherited from parent objects or parent groups.