com.crystaldecisions.sdk.occa.infostore
Interface IRightBase

All Superinterfaces:

IRightIDBase

All Known Subinterfaces:

IEffectiveRight, IExplicitRight, ISecurityRightAdmin

public interface IRightBase
extends IRightIDBase

This object provides information about a particular right on an object for a particular principal.

Method Summary

java.lang.String	getApplicableKind() Returns plugin kind the security item applies to.
int	getApplicableType() Returns plugin type the security item applies to.
java.lang.String	getDescription(java.util.Locale locale) Returns the description of the security item.
java.lang.String	getObjectType() Deprecated. Use getApplicableKind instead which has the same meaning but a more intuitive API name
RightDescriptor	getRightDescriptor() Returns the description used to identify the right
java.lang.String	getScope() Returns the right scope of the security item.
boolean	isGranted() Returns true if the right is granted, and false otherwise.
boolean	isSpecified() Returns true if the right is either explicit assigned or inherited from some parent object, and false if the right is not specified on current object or any parent objects.

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

getBaseID, getID, getRightPluginKind, getRightPluginType, isOwner

Method Detail

getDescription

java.lang.String getDescription(java.util.Locale locale)

Returns the description of the security item.

Parameters:

locale - A Locale object specifying the locale-specific display properties.

Returns:

The localized description of the security item as a String.

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. For example, if an "Edit Objects" right is assigned to a principal on an Info Object with the applicable kind set to Folder and scope set to "descendants", then this principal is only allowed to edit folder objects contained in current object.

Returns:

the specific object type the security item applies to

getApplicableType

int getApplicableType()

Returns plugin type the security item applies to. It's a numerical value corresponding to the applicable kind in getApplicableKind.

Returns:

the specific object type the security item applies to

getScope

java.lang.String getScope()

Returns the right scope of the security item. The value is defined in CeSecurityOptions.RightScope. The scope can be "this" or "descendants". "this" means that the assigned right is effective on the current object and "descendants" means it is effective on objects contained in current object.

Returns:

the right scope of the security item

isGranted

boolean isGranted()

Returns true if the right is granted, and false otherwise.

Returns:

true if the right is granted, and false otherwise.

isSpecified

boolean isSpecified()

Returns true if the right is either explicit assigned or inherited from some parent object, and false if the right is not specified on current object or any parent objects.

Returns:

true if the right is explicitly assigned or inherited, and false otherwise.

getRightDescriptor

RightDescriptor getRightDescriptor()

Returns the description used to identify the right

Returns:

right identifier