com.businessobjects.sdk.plugin.desktop.customrole
Interface IRoleRight

public interface IRoleRight

This interface contains the description of a right and the state (whether it is granted or denied).

Nested Class Summary

static interface

IRoleRight.Scope The scope of a right.

Method Summary

java.lang.String	getApplicableKind() Returns the plugin kind to which the right applies.
java.lang.String	getCategory(java.util.Locale locale) Deprecated. Use IPluginInfo.getName() instead
java.lang.String	getCollection(java.util.Locale locale) Deprecated. Use IPluginInfo.getTypeCollection(java.util.Locale) instead
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this right.
boolean	getGranted() Returns whether the right is granted.
int	getID() Returns the base ID of the right.
java.lang.String	getKind() Returns the plugin kind for which the right is defined.
boolean	getOwnerRight() Returns whether the right only applies to the owner of an object.
java.lang.String	getScope() Returns the scope of the right.
void	setApplicableKind(java.lang.String kind) Deprecated. Do not use. Instead, remove the right from the collection and add a new right where the applicable kind is configured in the RightDescriptor.
void	setGranted(boolean granted) Sets whether the right is granted.
void	setOwnerRight(boolean owner) Deprecated. Do not use. Instead, remove the right from the collection and add a new right where the owner flag is configured in the RightDescriptor.
void	setScope(java.lang.String scope) Deprecated. Do not use. Instead, remove the right from the collection and add a new right where the scope is configured in the RightDescriptor.

Method Detail

getID

int getID()

Returns the base ID of the right. Possible values are defined in com.crystaldecisions.sdk.occa.security.CeSecurityID.Right.

Returns:

The right ID.

getKind

java.lang.String getKind()

Returns the plugin kind for which the right is defined. The return value can be either an integer representing the plugin type ID or a String representing the plugin kind.

For system rights, use an empty string for the kind.

Returns:

the plugin kind for which the right is defined.

getOwnerRight

boolean getOwnerRight()

Returns whether the right only applies to the owner of an object.

Returns:

true if the right only applies to the owner, false otherwise.

setOwnerRight

void setOwnerRight(boolean owner)

Deprecated. Do not use. Instead, remove the right from the collection and add a new right where the owner flag is configured in the RightDescriptor.

See Also:

IRoleRights.addRoleRight(com.crystaldecisions.sdk.occa.infostore.RightDescriptor, boolean)

getApplicableKind

java.lang.String getApplicableKind()

Returns the plugin kind to which the right applies. When the applicable kind is set to a valid plugin kind, the right only applies to that kind of object.

Returns:

A string containing the plugin kind.

setApplicableKind

void setApplicableKind(java.lang.String kind)
                       throws SDKException

Deprecated. Do not use. Instead, remove the right from the collection and add a new right where the applicable kind is configured in the RightDescriptor.

Throws:

SDKException

See Also:

IRoleRights.addRoleRight(com.crystaldecisions.sdk.occa.infostore.RightDescriptor, boolean)

getScope

java.lang.String getScope()

Returns the scope of the right. The possible values are defined in IRoleRight.Scope.

Returns:

The scope.

setScope

void setScope(java.lang.String scope)
              throws SDKException

Deprecated. Do not use. Instead, remove the right from the collection and add a new right where the scope is configured in the RightDescriptor.

Throws:

SDKException

See Also:

IRoleRights.addRoleRight(com.crystaldecisions.sdk.occa.infostore.RightDescriptor, boolean)

getGranted

boolean getGranted()

Returns whether the right is granted.

Returns:

true if the right is granted, false otherwise.

setGranted

void setGranted(boolean granted)

Sets whether the right is granted.

Parameters:

granted - The new value of the right. set to true if the right is to be granted, false otherwise.

getDescription

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

Returns the localized description of this right.

Parameters:

locale - the locale for which to get the description

Returns:

The localized description of the right.

getCategory

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

Deprecated. Use IPluginInfo.getName() instead

Returns the localized category of this right.

Parameters:

locale - the locale for which to get the category

Returns:

The localized category of the right.

getCollection

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

Deprecated. Use IPluginInfo.getTypeCollection(java.util.Locale) instead

Returns the localized name of the collection to which the right belongs.

Parameters:

locale - the locale for which to get the collection

Returns:

A localized collection name.