com.crystaldecisions.sdk.occa.infostore
Interface IRightSource

public interface IRightSource

This interface defines the source of an effective right, i.e. where the effective right is explicit set. It specifies the object the right is set on, the principal it is assigned to, the type of objects it applies to, the scope of the right, and the custom access level the right is defined in if it's inherited from a custom access level. If the object ID equals to the current object, and the principal ID equals to the current principal, that means the effective right is the result of applying an explicit right assigned to the current principal on the current object.

Method Summary

java.lang.String	getApplicableKind() Returns plugin kind the security item applies to.
int	getObjectID() The ID of the object from which a security info is effectively inherited
java.lang.String	getObjectType() Deprecated. Use getApplicableKind instead which has the same meaning but a more intuitive API name
int	getPrincipalID() The ID of the principal from which a security info is effectively inherited
java.lang.String	getScope() The scope a security right applies to
int	getSourceRole() The id of role from which a security info is effectively derived
boolean	isFromRole() Flag indicating that a security info is from a role definition
boolean	isInherited() Returns true if the security info was inherited and not explicitly set on the object for which this right source was retrieved.

Method Detail

getObjectID

int getObjectID()

The ID of the object from which a security info is effectively inherited

Returns:

ID of the object from which a security info is effectively inherited

getPrincipalID

int getPrincipalID()

The ID of the principal from which a security info is effectively inherited

Returns:

ID of the principal from which a security info is effectively inherited

getObjectType

java.lang.String getObjectType()

Deprecated. Use getApplicableKind instead which has the same meaning but a more intuitive API name

getApplicableKind

java.lang.String getApplicableKind()

Returns plugin kind the security item applies to. When the applicable kind of a right is set to a particular plugin kind, this right is only applicable to the type of objects corresponding to this plugin kind.

Returns:

the specific object type the security right applies to

getScope

java.lang.String getScope()

The scope a security right applies to

Returns:

The scope a security right applies to. The return value is one of the values defined in CeSecurityOptions.RightScope

isFromRole

boolean isFromRole()

Flag indicating that a security info is from a role definition

Returns:

True if a security info is from a role definition; false otherwise

getSourceRole

int getSourceRole()

The id of role from which a security info is effectively derived

Returns:

The integer id of role object from which a security info is effectively derived

isInherited

boolean isInherited()

Returns true if the security info was inherited and not explicitly set on the object for which this right source was retrieved.

Returns:

true if the security info was inherited and not explicitly set on the object for which this right source was retrieved.