com.crystaldecisions.sdk.occa.infostore
Class RightDescriptor

java.lang.Object
  com.crystaldecisions.sdk.occa.infostore.RightIDDescriptor
      com.crystaldecisions.sdk.occa.infostore.RightDescriptor

public class RightDescriptor
extends RightIDDescriptor

This class contains information about a right, including the ID, the plugin type associated with the right, the owner flag, the scope, and the applicable kind.

Field Summary

java.lang.Object	applicableObjectType Returns the plugin kind to which the right applies.
java.lang.String	scope The scope of the right.

Fields inherited from class com.crystaldecisions.sdk.occa.infostore.RightIDDescriptor

id, isOwner, kind

Constructor Summary

RightDescriptor(int id)
Deprecated. Do not use. A right must be constructed with the base right ID, the plugin kind, and the owner flag. Use one of the other constructors.

RightDescriptor(int id, java.lang.Object kind, boolean isOwner)
This constructor takes the right ID, the right kind, and the owner flag.

RightDescriptor(int id, java.lang.Object kind, boolean isOwner, java.lang.String scope, java.lang.Object applicableObjectType)
This constructor takes the right ID, the right kind, the owner flag, the scope, and the applicable kind.

RightDescriptor(int id, java.lang.String scope, java.lang.Object applicableObjectType)
Deprecated. Do not use. A right must be constructed with the base right ID, the plugin kind, and the owner flag. Use one of the other constructors.

RightDescriptor(RightDescriptor right)
Copy constructor.

Method Summary

boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

scope

public java.lang.String scope

The scope of the right. The possible values are defined in CeSecurityOptions.RightScope.

applicableObjectType

public java.lang.Object applicableObjectType

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.

Note that this should not be confused with the RightIDDescriptor.kind field, which specifies the plugin that defines plugin specific rights (custom rights).

Constructor Detail

RightDescriptor

public RightDescriptor(int id)

Deprecated. Do not use. A right must be constructed with the base right ID, the plugin kind, and the owner flag. Use one of the other constructors.

RightDescriptor

public RightDescriptor(int id,
                       java.lang.Object kind,
                       boolean isOwner)

This constructor takes the right ID, the right kind, and the owner flag. Note that when this constructor is used, it implies that the right should apply to both "current object" and "descendants". As a result, use this constructor for updating security info but use the one with scope and applicableObjectType for retrieving security info.

Parameters:

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

kind - the plugin kind for which the right is defined It can be an Integer representing the plugin type ID or a String representing the plugin kind. For system rights, use an empty string.

isOwner - the boolean flag indicating that the right only applies to owner of an object

RightDescriptor

public RightDescriptor(int id,
                       java.lang.String scope,
                       java.lang.Object applicableObjectType)

Deprecated. Do not use. A right must be constructed with the base right ID, the plugin kind, and the owner flag. Use one of the other constructors.

RightDescriptor

public RightDescriptor(int id,
                       java.lang.Object kind,
                       boolean isOwner,
                       java.lang.String scope,
                       java.lang.Object applicableObjectType)

This constructor takes the right ID, the right kind, the owner flag, the scope, and the applicable kind.

Parameters:

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

kind - the plugin kind for which the right is defined. It can be an Integer representing the plugin type ID or a String representing the plugin kind. For system rights, use an empty string. string.

isOwner - set to true if the right only applies to the owner of an object

scope - the right scope. The possible values are defined in CeSecurityOptions.RightScope.

applicableObjectType - the plugin kind the right is applicable to. It can be an Integer representing the plugin type ID or a String representing the plugin kind. If the right applies to any type of object, use CeSecurityOptions.ANY_OBJTYPE.

RightDescriptor

public RightDescriptor(RightDescriptor right)

Copy constructor. Constructs the right descriptor by copying values from an existing object.

Parameters:

right - the right descriptor to be copied

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class RightIDDescriptor

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class RightIDDescriptor

toString

public java.lang.String toString()

Overrides:

toString in class RightIDDescriptor