com.crystaldecisions.sdk.occa.infostore
Interface IRightID

public interface IRightID

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

Method Summary

java.lang.String	getCategory(java.util.Locale locale) Returns a localized category of this right.
java.lang.String	getDescription(java.util.Locale locale) Returns a localized description of this right.
int	getID() Returns the ID of this right.
boolean	isOwner() Returns true if this is an owner specific right, false otherwise.

Method Detail

getDescription

public 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

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

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.

getID

public int getID()

Returns the ID of this right.

Returns:

The right's ID.

isOwner

public 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.