com.crystaldecisions.sdk.occa.infostore
Interface ISecurityRight


public interface ISecurityRight

This object provides information about the rights that are set on an object for a particular principal.


Method Summary
 java.lang.String getDescription(java.util.Locale locale)
           The localized description of the right.
 int getID()
           Returns the right's ID.
 boolean isGranted()
           Returns true if the right is granted, and false otherwise.
 boolean isInherited()
           Returns true if the right is inherited, and false otherwise.
 boolean isOwner()
           Returns true if this is an owner specific right, false otherwise.
 void setGranted(boolean granted)
           Sets whether a right is granted.
 

Method Detail

isGranted

public boolean isGranted()

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

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

setGranted

public void setGranted(boolean granted)

Sets whether a right is granted. This value should be set to true if the right is to be granted, and false otherwise.

Parameters:
granted - The new value of the right. This value should be set to true if the right is to be granted, and false otherwise.

getID

public int getID()

Returns the right's ID.

Returns:
The ID of this right as an int.

isInherited

public boolean isInherited()

Returns true if the right is inherited, and false otherwise. If the right is inherited it cannot be changed on this object.

Returns:
true if the right is inherited, and false otherwise.

isOwner

public boolean isOwner()

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

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

getDescription

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

The localized description of the right.

Parameters:
locale - The Locale object used to specify the description's display properties.
Returns:
A String containing the localized description of the right.