Skip navigation links

oracle.iam.provisioning.api
Interface EntitlementService

public interface EntitlementService

Method Summary

Entitlement	addEntitlement(Entitlement entitlement) Populates entitlement list table with one new entitlement
java.util.List	addEntitlements(java.util.List entitlements) Adds records for Entitlements using multiple value objects for Entitlement
boolean	deleteEntitlement(long entitlementKey) Soft Deletes entitlement list row from entitlement list table by marking valid as 0 in the list of entitlements.
void	deleteEntitlements(long[] entitlementKeys) Deletes records of Entitlements using multiple value-objects of Entitlement
Entitlement	findEntitlement(long entitlementKey) Gets entitlement details for an entitlement from the ENT_LIST by entitlement key.
Entitlement	findEntitlement(long entitlementKey, OperationContext operationContext) Gets entitlement details for an entitlement from the ENT_LIST by entitlement key.
java.util.List	findEntitlements(SearchCriteria criteria, java.util.HashMap configParams) Searches for entitlements matching the specified SearchCriteria.
Entitlement	updateEntitlement(Entitlement entitlement) Updates entitlement list table with the given entitlement
java.util.List	updateEntitlements(java.util.List entitlements) Modifies records for Entitlements using multiple value-objects for Entitlement

Method Detail

addEntitlement

Entitlement addEntitlement(Entitlement entitlement)
                           throws ITResourceNotFoundException,
                                  ObjectNotFoundException,
                                  DuplicateEntitlementException,
                                  GenericEntitlementServiceException,
                                  FormFieldNotFoundException,
                                  LookupValueNotFoundException,
                                  FormNotFoundException,
                                  AccessDeniedException

Populates entitlement list table with one new entitlement

Parameters:

entitlement - entitlement value object that contains all the required attribtues

Returns:

the entitlement value object that contains the key of the entitlement created

Throws:

ITResourceNotFoundException - if ITResource Key present in Entitlement VO does not exist.

ObjectNotFoundException - if Object Key present in Entitlement VO does not exist

DuplicateEntitlementException - if the entitlement already exists

GenericEntitlementServiceException - if errors occur while saving the data

FormFieldNotFoundException - if Form Field key present in Entitlement VO does not exist

LookupValueNotFoundException - if Lookup Value key present in Entitlement VO does not exist

FormNotFoundException - if Form Key present in Entitlement VO does not exist

AccessDeniedException - if there are authorization failures while adding entitlement

Since:

11.1.2.0.0

updateEntitlement

Entitlement updateEntitlement(Entitlement entitlement)
                              throws EntitlementNotFoundException,
                                     GenericEntitlementServiceException,
                                     AccessDeniedException

Updates entitlement list table with the given entitlement

Parameters:

entitlement - entitlement value object that the key and the attribtues of the entitlement that needs to be updated

Returns:

entitlement value object that contains the key of the entitlement updated

Throws:

EntitlementNotFoundException - if the entitlement does not exist

GenericEntitlementServiceException - if errors occur while saving the data

AccessDeniedException - if there are authorization failures while updating entitlement

Since:

11.1.2.0.0

deleteEntitlement

boolean deleteEntitlement(long entitlementKey)
                          throws GenericEntitlementServiceException,
                                 AccessDeniedException

Soft Deletes entitlement list row from entitlement list table by marking valid as 0 in the list of entitlements.

Parameters:

entitlementKey - the primary key of ent_list table (ent_list_key)

Throws:

GenericEntitlementServiceException - if errors occur while saving the data

AccessDeniedException - if there are authorization failures while deleting entitlement

Since:

11.1.2.0.0

findEntitlement

Entitlement findEntitlement(long entitlementKey,
                            OperationContext operationContext)
                            throws GenericEntitlementServiceException,
                                   EntitlementNotFoundException

Gets entitlement details for an entitlement from the ENT_LIST by entitlement key.

Parameters:

entitlementKey - the primary key of ent_list table ent_list_key

operationContext - the object extracted from requestContext in approval scenario

Returns:

the entitlement value object with all attributes populated

Throws:

GenericEntitlementServiceException - if errors occur while retrieving the data

AccessDeniedException - if there are authorization failures while finding entitlement

EntitlementNotFoundException

Since:

11.1.2.0.0

findEntitlement

Entitlement findEntitlement(long entitlementKey)
                            throws GenericEntitlementServiceException,
                                   EntitlementNotFoundException

Gets entitlement details for an entitlement from the ENT_LIST by entitlement key.

Parameters:

entitlementKey - the primary key of ent_list table ent_list_key

Returns:

the entitlement value object with all attributes populated

Throws:

GenericEntitlementServiceException - if errors occur while retrieving the data

AccessDeniedException - if there are authorization failures while finding entitlement

EntitlementNotFoundException

Since:

11.1.2.0.0

findEntitlements

java.util.List findEntitlements(SearchCriteria criteria,
                                java.util.HashMap configParams)
                                throws GenericEntitlementServiceException

Searches for entitlements matching the specified SearchCriteria.

Parameters:

criteria - The search criteria based on which entries will be retrieved from the backend. The SearchCriteria Operators supported are AND, OR, NOT, GREATER_THAN, GREATER_EQUAL, LESS_THAN, LESS_EQUAL, EQUAL and NOT_EQUAL. For additional comparisons like contains the SearchCriteria Operator will be EQUAL with value to be searched will be '*<value>*'

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched. These parameters are mandatory.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional

The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING.

Returns:

the list of entitlements which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in User.

Throws:

GenericEntitlementServiceException - if errors occur

Since:

11.1.2.0.0

addEntitlements

java.util.List addEntitlements(java.util.List entitlements)
                               throws BulkException

Adds records for Entitlements using multiple value objects for Entitlement

Parameters:

entitlements - The list of Entitlement value objects

Returns:

The list of Entitlement value objects containing the key of the Entitlement created

Throws:

BulkException - if errors occur while adding the list of entitlement value objects

AccessDeniedException - if there are authorization failures while adding entitlements

Since:

11.1.2.0.0

updateEntitlements

java.util.List updateEntitlements(java.util.List entitlements)
                                  throws BulkException

Modifies records for Entitlements using multiple value-objects for Entitlement

Parameters:

entitlements - The list of Entitlement value objects

Returns:

The list of Entitlement value objects containing the key of the Entitlement created.

Throws:

BulkException - thrown if errors occur while adding the list of entitlement value objects

AccessDeniedException - if there are authorization failures while updating entitlements

Since:

11.1.2.0.0

deleteEntitlements

void deleteEntitlements(long[] entitlementKeys)
                        throws BulkException

Deletes records of Entitlements using multiple value-objects of Entitlement

Parameters:

entiltementKeys - The array of entitlement keys

Throws:

BulkException - if errors occur while adding the list of entitlement value objects

AccessDeniedException - if there are authorization failures while deleting entitlements

Since:

11.1.2.0.0

Skip navigation links