blackboard.platform.security
Class Entitlement

java.lang.Object
  blackboard.platform.security.Entitlement

public class Entitlement
extends java.lang.Object

The Entitlement class represents a permission for an action on a given type of object in the Blackboard application, within a given context ( i.e, the permission to view content in a course ). Entitlements have a "unique id" (UID) that is used for comparisons.

See Also:

AccessManagerService

Field Summary

static DataType	DATA_TYPE
protected java.lang.String	entitlementUid
protected Id	id

Constructor Summary

Entitlement()
Creates an instance of Entitlement with default property values.

Entitlement(java.lang.String uid)
Convenience method to create an Entitlement based on a given UID.

Method Summary

boolean	equals(java.lang.Object o)
DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getEntitlementUid() Return the unique identifier associated with this Entitlement.
Id	getId()
int	hashCode()
void	setEntitlementUid(java.lang.String uid)
void	setId(Id id)
java.lang.String	toString()
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE

entitlementUid

protected java.lang.String entitlementUid

id

protected Id id

Constructor Detail

Entitlement

public Entitlement()

Creates an instance of Entitlement with default property values.

Entitlement

public Entitlement(java.lang.String uid)

Convenience method to create an Entitlement based on a given UID.

Parameters:

uid - UID of the entitlement to create.

Method Detail

getEntitlementUid

public java.lang.String getEntitlementUid()

Return the unique identifier associated with this Entitlement.

Returns:

String UID

setEntitlementUid

public void setEntitlementUid(java.lang.String uid)

getId

public Id getId()

setId

public void setId(Id id)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

validate

public void validate()
              throws ValidationException

Throws:

ValidationException

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Returns:

the DataType for this object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object