com.crystaldecisions.sdk.occa.infostore
Interface IEffectiveRole

All Known Subinterfaces:
ISecurityRoleAdmin

public interface IEffectiveRole

This object provides information about a custom access level (custom role) that is effective to an object for a particular principal.


Method Summary
 int getID()
           Returns the custom access level's ID.
 java.util.List getSources()
           Returns the set of sources from which the custom access level is effectively inherited If an effective role is the result of an explicit role set on the Info Object, the sources will contain an entry that refers to the current object and the current principal.
 java.lang.String getTitle()
           Returns the title of the custom access level.
 boolean isInherited()
          Returns whether the custom access level is inherited from a parent object or a parent group.
 

Method Detail

getID

int getID()

Returns the custom access level's ID.

Returns:
The ID of this custom access level as an int.

getTitle

java.lang.String getTitle()

Returns the title of the custom access level.

Returns:
The title of the custom access level as a String.

getSources

java.util.List getSources()

Returns the set of sources from which the custom access level is effectively inherited If an effective role is the result of an explicit role 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 IRoleSource.

isInherited

boolean isInherited()
Returns whether the custom access level is inherited from a parent object or a parent group.

Returns:
true if the custom access level is inherited from a parent object or a parent group