com.crystaldecisions.sdk.occa.infostore
Interface IRightIDBase

All Known Subinterfaces:

IEffectiveLimit, IEffectiveRight, IExplicitLimit, IExplicitRight, IRestrictedRight, IRightBase, IRightID, ISecurityLimitAdmin, ISecurityRightAdmin

public interface IRightIDBase

This interface defines a set of methods describing the elements that make up the authentic right id

Method Summary

int	getBaseID() Returns the base ID of this right.
int	getID() Deprecated. Since version 12.0, use rest of the calls defined in this interface to get the breakdown components of a right id which includes the right base id, the owner flag, and the plugin type/kind of the right
java.lang.String	getRightPluginKind() Returns the kind of this right if it's a custom right(i.e. plugin specific right).
int	getRightPluginType() Returns the plugin type of this right if it's a custom right(i.e. plugin specific right).
boolean	isOwner() Returns true if this is an owner specific right, false otherwise.

Method Detail

getID

int getID()

Deprecated. Since version 12.0, use rest of the calls defined in this interface to get the breakdown components of a right id which includes the right base id, the owner flag, and the plugin type/kind of the right

Returns the ID of this right.

Returns:

The right's ID.

isOwner

boolean isOwner()

Returns true if this is an owner specific right, false otherwise. An owner specific right only applies if the principal is the owner of the object.

Returns:

true if this is an owner specific right, false otherwise.

getBaseID

int getBaseID()

Returns the base ID of this right.

Returns:

The right's base ID.

getRightPluginKind

java.lang.String getRightPluginKind()

Returns the kind of this right if it's a custom right(i.e. plugin specific right). Otherwise, if the right is a system right, the returned string will be empty. If the type information embedded in the custom right ID is not recognized as a valid plugin type or if the plugin manager is not available to calculate the associating plugin kind, the function returns null.

Returns:

The plugin kind of the right if the right is a custom right; empty string if the right is a system right; and null if the custom right does not belong to any valid plugin type or if the plugin manager is not available to calculate the associating plugin kind.

getRightPluginType

int getRightPluginType()

Returns the plugin type of this right if it's a custom right(i.e. plugin specific right). Otherwise, if the right is a system right, the returned value will be 0. Note that the method does not check for the validity of the type id which is different from getRightPluginKind where the plugin kind is checked for its validity.

Returns:

Returns the plugin type of this right if it's a custom right(i.e. plugin specific right). Otherwise, if the right is a system right, the returned value will be 0