com.crystaldecisions.sdk.occa.infostore
Interface IRightID

All Superinterfaces:

IRightIDBase

public interface IRightID
extends IRightIDBase

This interface defines interactions that allow information to be obtained from an object right.

Method Summary

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() instead
java.lang.String	getDescription(java.util.Locale locale) Returns a localized description of this right.

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 a localized description of this right.

Parameters:

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

Returns:

A localized description of the right as a String.

getCategory

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

Deprecated. Use IPluginInfo.getName() instead

Returns a localized category of this right.

Parameters:

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

Returns:

A localized category of the right as a String.

getCollection

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

Deprecated. Use IPluginInfo.getTypeCollection() instead

Returns a localized string representing which collection this right belongs to.

Parameters:

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

Returns:

A localized string representing which collection this right belongs to as a String.