Package oracle.iam.provisioning.api

Interface EntitlementService

public interface EntitlementService
EntitlementService application programming interface provides methods needed to create and manage Entitlement for both connected and disconnected ApplicationInstance. We are exposing the following Entitlement Management APIs. These consumers of these APIs will be: - New Application Instance U/I to perform CRUD operations on Entitlements - Request Engine to get further information regarding the Entitlements, including the dataset name. - New U/I My Entitlements screen to display the Entitlements granted to a user - Connectors - Custom Clients, who want to programmatically manage Entitlements
Since:
11.1.2.0.0
Author:
Various
See Also:

  • Method Details

    • addEntitlement

      Entitlement addEntitlement(Entitlement entitlement) throws ITResourceNotFoundException, ObjectNotFoundException, DuplicateEntitlementException, GenericEntitlementServiceException, FormFieldNotFoundException, LookupValueNotFoundException, FormNotFoundException, AccessDeniedException
      This API method adds a record for entitlement using Entitlement value-object.
      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
      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
      GenericEntitlementServiceException - if errors occur while saving the data
      Since:
      11.1.2.0.0

    • updateEntitlement

      Entitlement updateEntitlement(Entitlement entitlement) throws EntitlementNotFoundException, GenericEntitlementServiceException, AccessDeniedException
      This API method 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
      AccessDeniedException - if there are authorization failures while updating entitlement
      GenericEntitlementServiceException - if errors occur while saving the data
      Since:
      11.1.2.0.0

    • deleteEntitlement

      boolean deleteEntitlement(long entitlementKey) throws GenericEntitlementServiceException, AccessDeniedException
      This API method soft deletes entitlement from entitlement list (ENT_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:
      AccessDeniedException - if there are authorization failures while deleting entitlement
      GenericEntitlementServiceException - if errors occur while saving the data
      Since:
      11.1.2.0.0

    • findEntitlement

      Entitlement findEntitlement(long entitlementKey, OperationContext operationContext) throws GenericEntitlementServiceException, EntitlementNotFoundException
      This API method 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:
      EntitlementNotFoundException - if the entitlement does not exist
      GenericEntitlementServiceException - if errors occur while retrieving the data
      Since:
      11.1.2.0.0

    • findEntitlement

      Entitlement findEntitlement(long entitlementKey) throws GenericEntitlementServiceException, EntitlementNotFoundException
      This API method 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:
      EntitlementNotFoundException - if the entitlement does not exist
      GenericEntitlementServiceException - if errors occur while retrieving the data
      Since:
      11.1.2.0.0

    • findEntitlements

      List<Entitlement> findEntitlements(SearchCriteria criteria, HashMap<String,Object> configParams) throws GenericEntitlementServiceException
      This API method 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 '**'
      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

      List<Entitlement> addEntitlements(List<Entitlement> entitlements) throws BulkException
      This API method adds the multiple records of Entitlements using 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
      Since:
      11.1.2.0.0

    • updateEntitlements

      List<Entitlement> updateEntitlements(List<Entitlement> entitlements) throws BulkException
      This API method 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 - if errors occur while adding the list of entitlement value objects
      Since:
      11.1.2.0.0

    • deleteEntitlements

      void deleteEntitlements(long[] entitlementKeys) throws BulkException
      This API method 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
      Since:
      11.1.2.0.0