Skip navigation links

oracle.iam.provisioning.vo
Class Entitlement

java.lang.Object
oracle.iam.provisioning.vo.Entitlement

All Implemented Interfaces:

java.io.Serializable

public class Entitlement

extends java.lang.Object

implements java.io.Serializable

This value object represents an Entitlement definition. Since Entitlement is a first class entity, it is represented by this value object. The child table field is considered as Entitlement if the property Entitlement = true is marked for the child table form field. Child form fields of type LookupField are generally marked with this property. The values (records) for such lookup field are reconciled from target system via Reconciliation Lookup schedule Job, which brings these records into LKV table. Then "ENT_LIST Job" is run to populate lookup entries marked as Entitlement into ENT_LIST table. When Catalog Synchronization job is run, all valid Entitlements are populated in CATALOG table, which are available for request via Catalog feature. Thus, the flow if data for Entitlement population is as follows: Target System --> LKV --> ENT_LIST --> CATALOG

Since:

11.1.2.0.0

See Also:

Serialized Form

Field Summary

static java.lang.String	ENDROW Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the ending row in case of pagination
static java.lang.String	ENTITLEMENT_DESCRIPTION Search Criteria parameter - search by the description of the Entitlement
static java.lang.String	ENTITLEMENT_DISPLAYNAME Search Criteria parameter - search by the display name of the Entitlement
static java.lang.String	ENTITLEMENT_FORMFIELDKEY Search Criteria parameter - search by the form field key (sdc_key) on which this entitlement is defined.
static java.lang.String	ENTITLEMENT_FORMKEY Search Criteria parameter - search by the form key (child form) on which this entitlement is defined.
static java.lang.String	ENTITLEMENT_ITRESOURCEKEY Search Criteria parameter - search by the ITResource key for which this entitlement is defined.
static java.lang.String	ENTITLEMENT_KEY Search Criteria parameter - search by the primary key of the Entitlement in the ENT_LIST table
static java.lang.String	ENTITLEMENT_LOOKUPVALUEKEY Search Criteria parameter - search by the lookup value key (lku_key)
static java.lang.String	ENTITLEMENT_NAME Search Criteria parameter - search by the the entitlement code (lkv_encoded)
static java.lang.String	ENTITLEMENT_OBJECTKEY Search Criteria parameter - search by the resource object key for which this entitlement is defined.
static java.lang.String	ENTITLEMENT_VALID Search Criteria parameter - search by the field indicating if the entitlement is valid
static java.lang.String	ENTITLEMENT_VALUE Search Criteria parameter - search by the entitlement value (lkv_decoded)
static java.lang.String	OPERATIONCONTEXT
static long	serialVersionUID
static java.lang.String	SORTEDBY Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the sortby column
static java.lang.String	SORTORDER Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the sortorder
static java.lang.String	STARTROW Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the starting row in case of pagination

Constructor Summary

Entitlement()

Method Summary

boolean	equals(java.lang.Object obj)
ApplicationInstance	getAppInstance()
FormInfo	getChildForm()
java.lang.String	getDescription() This method gets the description of the Entitltment (ENT_DESCRIPTION).
java.lang.String	getDisplayName() This method gets the display name of the Entitltment (ENT_DISPLAY_NAME).
java.lang.String	getEntitlementCode() This method gets the Entitlement Code associated to the Entitltment (ENT_CODE).
long	getEntitlementKey() This method gets the primary key of the Entitltment (ENT_LIST_KEY)
java.lang.String	getEntitlementValue() This method gets the Entitlement value associated to the Entitltment (ENT_VALUE).
long	getFormFieldKey() This method gets the form field key associated to Entitlement (SDC_KEY).
long	getFormKey() This method gets the Form Key associated to the Entitltment (SDK_KEY).
java.lang.String	getFormName() This method gets the form name to Entitlement (SDK_NAME).
long	getItResourceKey() This method gets the ITResource Key associated to the Entitltment (SVR_KEY).
long	getLookupValueKey() This method gets the Lookup value Key associated to the Entitltment (LKV_KEY).
long	getObjectKey() This method gets the Resource Object Key associated to the Entitltment (OBJ_KEY).
int	hashCode()
boolean	isValid() This method checks if Entitlement is valid.
void	setAppInstance(ApplicationInstance appInstance)
void	setChildForm(FormInfo childForm)
void	setDescription(java.lang.String description) This method sets the description of the Entitltment (ENT_DESCRIPTION).
void	setDisplayName(java.lang.String displayName) This method sets the display name of the Entitltment (ENT_DISPLAY_NAME).
void	setEntitlementCode(java.lang.String entitlementCode) This method sets the Entitlement Code to the Entitltment (ENT_CODE).
void	setEntitlementKey(long entitlementKey) This method sets the primary key of the Entitltment (ENT_LIST_KEY)
void	setEntitlementValue(java.lang.String entitlementValue) This method sets the Entitlement value associated to the Entitltment (ENT_VALUE).
void	setFormFieldKey(long formFieldKey) This method sets the form field key to Entitlement (SDC_KEY).
void	setFormKey(long formKey) This method sets the Form Key to the Entitltment (SDK_KEY).
void	setFormName(java.lang.String formName) This method sets the form name to Entitlement (SDK_NAME).
void	setItResourceKey(long itResourceKey) This method sets the ITResource Key to the Entitltment (SVR_KEY).
void	setLookupValueKey(long lookupValueKey) This method sets the Lookup value Key to the Entitltment (LKV_KEY).
void	setObjectKey(long objectKey) This method sets the Resource Object Key associated to the Entitltment (OBJ_KEY).
void	setValid(boolean isValid) This method sets if Entitlement is valid.
java.lang.String	toString() This method returns the String representation of the Entitlement in the format, EntitlementCode: ITResourceKey: ResourceObjectKey

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

STARTROW

public static final java.lang.String STARTROW

Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the starting row in case of pagination

See Also:

Constant Field Values

ENDROW

public static final java.lang.String ENDROW

Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the ending row in case of pagination

See Also:

Constant Field Values

SORTORDER

public static final java.lang.String SORTORDER

Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the sortorder

See Also:

Constant Field Values

SORTEDBY

public static final java.lang.String SORTEDBY

Search configuration parameter - if the search result returns bulk of entitlements, this parameter is used to specify the sortby column

See Also:

Constant Field Values

OPERATIONCONTEXT

public static final java.lang.String OPERATIONCONTEXT

See Also:

Constant Field Values

ENTITLEMENT_KEY

public static final java.lang.String ENTITLEMENT_KEY

Search Criteria parameter - search by the primary key of the Entitlement in the ENT_LIST table

See Also:

Constant Field Values

ENTITLEMENT_NAME

public static final java.lang.String ENTITLEMENT_NAME

Search Criteria parameter - search by the the entitlement code (lkv_encoded)

See Also:

Constant Field Values

ENTITLEMENT_VALUE

public static final java.lang.String ENTITLEMENT_VALUE

Search Criteria parameter - search by the entitlement value (lkv_decoded)

See Also:

Constant Field Values

ENTITLEMENT_DISPLAYNAME

public static final java.lang.String ENTITLEMENT_DISPLAYNAME

Search Criteria parameter - search by the display name of the Entitlement

See Also:

Constant Field Values

ENTITLEMENT_DESCRIPTION

public static final java.lang.String ENTITLEMENT_DESCRIPTION

Search Criteria parameter - search by the description of the Entitlement

See Also:

Constant Field Values

ENTITLEMENT_OBJECTKEY

public static final java.lang.String ENTITLEMENT_OBJECTKEY

Search Criteria parameter - search by the resource object key for which this entitlement is defined.

See Also:

Constant Field Values

ENTITLEMENT_ITRESOURCEKEY

public static final java.lang.String ENTITLEMENT_ITRESOURCEKEY

Search Criteria parameter - search by the ITResource key for which this entitlement is defined.

See Also:

Constant Field Values

ENTITLEMENT_VALID

public static final java.lang.String ENTITLEMENT_VALID

Search Criteria parameter - search by the field indicating if the entitlement is valid

See Also:

Constant Field Values

ENTITLEMENT_FORMFIELDKEY

public static final java.lang.String ENTITLEMENT_FORMFIELDKEY

Search Criteria parameter - search by the form field key (sdc_key) on which this entitlement is defined.

See Also:

Constant Field Values

ENTITLEMENT_FORMKEY

public static final java.lang.String ENTITLEMENT_FORMKEY

Search Criteria parameter - search by the form key (child form) on which this entitlement is defined.

See Also:

Constant Field Values

ENTITLEMENT_LOOKUPVALUEKEY

public static final java.lang.String ENTITLEMENT_LOOKUPVALUEKEY

Search Criteria parameter - search by the lookup value key (lku_key)

See Also:

Constant Field Values

Constructor Detail

Entitlement

public Entitlement()

Method Detail

getEntitlementKey

public long getEntitlementKey()

This method gets the primary key of the Entitltment (ENT_LIST_KEY)

Returns:

The primary key of the Entitlement.

setEntitlementKey

public void setEntitlementKey(long entitlementKey)

This method sets the primary key of the Entitltment (ENT_LIST_KEY)

Parameters:

entitlementKey - The primary key of the Entitlement.

getDisplayName

public java.lang.String getDisplayName()

This method gets the display name of the Entitltment (ENT_DISPLAY_NAME). By default LKV_DECODED is the Entitlement display name. However, one can call Entitlement management API to set the new display name for the Entitlement.

Returns:

display name of the Entitlement.

setDisplayName

public void setDisplayName(java.lang.String displayName)

This method sets the display name of the Entitltment (ENT_DISPLAY_NAME).

Parameters:

displayName - display name of the Entitlement.

getDescription

public java.lang.String getDescription()

This method gets the description of the Entitltment (ENT_DESCRIPTION).

Returns:

the description of the Entitltment.

setDescription

public void setDescription(java.lang.String description)

This method sets the description of the Entitltment (ENT_DESCRIPTION).

Parameters:

description - the description of the Entitltment.

getObjectKey

public long getObjectKey()

This method gets the Resource Object Key associated to the Entitltment (OBJ_KEY).

Returns:

the Resource Object Key.

setObjectKey

public void setObjectKey(long objectKey)

This method sets the Resource Object Key associated to the Entitltment (OBJ_KEY).

Parameters:

objectKey - the Resource Object Key.

getItResourceKey

public long getItResourceKey()

This method gets the ITResource Key associated to the Entitltment (SVR_KEY). There can be multiple Entitlements available in the system with same display name, but with different ITResource Key.

Returns:

the ITResource Key associated to the Entitltment (SVR_KEY).

setItResourceKey

public void setItResourceKey(long itResourceKey)

This method sets the ITResource Key to the Entitltment (SVR_KEY).

Parameters:

itResourceKey -

getFormKey

public long getFormKey()

This method gets the Form Key associated to the Entitltment (SDK_KEY).

Returns:

the Form Key associated to the Entitltment (SDK_KEY).

setFormKey

public void setFormKey(long formKey)

This method sets the Form Key to the Entitltment (SDK_KEY).

Parameters:

formKey - the Form Key associated to the Entitltment (SDK_KEY).

getLookupValueKey

public long getLookupValueKey()

This method gets the Lookup value Key associated to the Entitltment (LKV_KEY).

Returns:

the Lookup value Key associated to the Entitltment (LKV_KEY).

setLookupValueKey

public void setLookupValueKey(long lookupValueKey)

This method sets the Lookup value Key to the Entitltment (LKV_KEY).

Parameters:

lookupValueKey - the Lookup value Key to the Entitltment (LKV_KEY).

getEntitlementCode

public java.lang.String getEntitlementCode()

This method gets the Entitlement Code associated to the Entitltment (ENT_CODE). This will be same as LKV_ENCODED

Returns:

the Entitlement Code associated to the Entitltment (ENT_CODE).

setEntitlementCode

public void setEntitlementCode(java.lang.String entitlementCode)

This method sets the Entitlement Code to the Entitltment (ENT_CODE). This will be same as LKV_ENCODED

Parameters:

entitlementCode -

getEntitlementValue

public java.lang.String getEntitlementValue()

This method gets the Entitlement value associated to the Entitltment (ENT_VALUE).

Returns:

the Entitlement value associated to the Entitltment (ENT_VALUE).

setEntitlementValue

public void setEntitlementValue(java.lang.String entitlementValue)

This method sets the Entitlement value associated to the Entitltment (ENT_VALUE).

Parameters:

entitlementValue - the Entitlement value associated to the Entitltment (ENT_VALUE).

isValid

public boolean isValid()

This method checks if Entitlement is valid. If ApplicationInstance and/or ITResource and/or ResourceObject is deleted, the Entitlements associated with such ApplicationInstance will be marked as inValid. i.e ENT_VALID = 0. Such Entitlements will then synched with CATALOG and will be marked as non-request able entities.

Returns:

setValid

public void setValid(boolean isValid)

This method sets if Entitlement is valid.

Parameters:

isValid - true means valid.

getFormFieldKey

public long getFormFieldKey()

This method gets the form field key associated to Entitlement (SDC_KEY).

Returns:

the form field key associated to Entitlement (SDC_KEY).

setFormFieldKey

public void setFormFieldKey(long formFieldKey)

This method sets the form field key to Entitlement (SDC_KEY).

Parameters:

formFieldKey - the form field key associated to Entitlement (SDC_KEY).

getFormName

public java.lang.String getFormName()

This method gets the form name to Entitlement (SDK_NAME).

Parameters:

formName - the form name associated to Entitlement (SDK_NAME).

setFormName

public void setFormName(java.lang.String formName)

This method sets the form name to Entitlement (SDK_NAME).

Parameters:

formName - the form name associated to Entitlement (SDK_NAME).

getChildForm

public FormInfo getChildForm()

setChildForm

public void setChildForm(FormInfo childForm)

toString

public java.lang.String toString()

This method returns the String representation of the Entitlement in the format, EntitlementCode: ITResourceKey: ResourceObjectKey

Overrides:

toString in class java.lang.Object

getAppInstance

public ApplicationInstance getAppInstance()

setAppInstance

public void setAppInstance(ApplicationInstance appInstance)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Skip navigation links