Package oracle.iam.certification.api

Interface CertificationService

public interface CertificationService
The public API to the OIM Certification Feature. The primary consumer of this API is the OIM self-service UI.

  • Field Details

  • Method Details

    • findCertifications

      List<CertificationInstance> findCertifications(SearchCriteria searchCriteria, Set<String> retAttrs, Map<String,Object> configParams) throws CertificationServiceException
      This method finds a list of certifications according to given searchcriteria, set of return attributes and config params
      Parameters:
      searchCriteria - - search criteria information indicating which certification objects to retrieve.
      retAttrs - - set of attributes to be filled in for each object returned.
      configParams - - configParams Parameters to configure ordering and range of results.
      Returns:
      list of CertificationInstance(s)
      Throws:
      CertificationServiceException

    • countCertifications

      long countCertifications(SearchCriteria searchCriteria)
      This method counts the number of certifications matching the supplied search criteria.
      Parameters:
      searchCriteria -
      Returns:
      - Number of certifications matching search criteria

    • completeCertification

      CertificationInstance completeCertification(Long certificationId, String taskUid, char[] cleartextPassword) throws InvalidPasswordException, NotYetCompletedException, InvalidArgumentException, CertificationIllegalStateException
      This method completes the certification having the given id.
      Parameters:
      certificationId - - certification Id
      taskUid - must be null (method applies only to certification instances)
      cleartextPassword - - cleartext oim password
      Returns:
      list of CertificationInstance(s)
      Throws:
      InvalidPasswordException - In case a password is required and the caller supplies an invalid one
      NotYetCompletedException - In case certification task has unreviewed line-items
      InvalidArgumentException - In case the taskUid argument is not null, the certificationId is not valid, or the password is not encrypted properly
      CertificationIllegalStateException - In case the certification is already completed

    • completeCertificationTask

      void completeCertificationTask(Long certificationId, String taskUid, char[] cleartextPassword) throws InvalidPasswordException, NotYetCompletedException, InvalidArgumentException, CertificationIllegalStateException, CertificationServiceException
      completes a certification task.
      Parameters:
      certificationId - - Certification Id
      taskUid - - non-null id of the task to be signed-off ( completed )
      cleartextPassword - - cleartext password for current logged in user
      Throws:
      InvalidPasswordException - In case a password is required and the caller supplies an invalid one
      NotYetCompletedException - In case certification task has unreviewed line-items
      InvalidArgumentException
      CertificationIllegalStateException
      CertificationServiceException

    • canBeCompleted

      boolean canBeCompleted(Long certificationId, String taskUid) throws CertificationServiceException
      Determine if a certification is ready to be completed or a task associated with a certification is ready to be signed off. The task ID may be null.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      Returns:
      - true if ready, false if not
      Throws:
      CertificationServiceException

    • findCertificationHistoryForRole

      List<CertificationHistory> findCertificationHistoryForRole(String roleKey, SearchCriteria searchCriteria)
      Return list of certification history objects for a given roleKey.
      Parameters:
      roleKey - - roleId (roleKey).
      searchCriteria - - SearchCrieteria based on from and to date for which history is required.
      Returns:
      list of CertificationHistory objects.

    • getCertificationStats

      CertificationStats getCertificationStats(Long certId, String taskUid) throws CertificationServiceException
      Get an abstract CertStats object. Used when only percentComplete is needed.
      Parameters:
      certId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      Returns:
      a CertificationStats object that is an instance of 1 of the 4 types: User, Role, AppInst, Entitlement
      Throws:
      CertificationServiceException

    • loadCertification

      CertificationInstance loadCertification(Long certificationId) throws CertificationServiceException
      Deprecated.
      use loadCertification(Long certificationId, String taskUid)
      Throws:
      CertificationServiceException

    • loadCertification

      CertificationInstance loadCertification(Long certificationId, String taskUid) throws CertificationServiceException
      Returns a CertificationInstance object for given certification Id and task Id
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      Returns:
      a CertificationInstance object for given certification Id and task Id
      Throws:
      CertificationServiceException

    • getCertificationConfiguration

      IDCConfiguration getCertificationConfiguration(Long certificationId, String taskUid) throws CertificationServiceException
      Retrieve the configuration set in the certification at instantiation
      Parameters:
      certificationId - The certification entity ID
      taskUid - When invoking this method from an inbox (workflow) context, supply the external task ID; otherwise, supply null
      Returns:
      The configuration set in the certification at instantiation
      Throws:
      CertificationServiceException - In case of server error
      See Also:

    • getCertificationGlobalConfiguration

      IDCConfiguration getCertificationGlobalConfiguration(Long certificationId, String taskUid) throws CertificationServiceException
      Retrieve the global certification configuration. Use this method when the current setting of a configuration attribute is needed
      Parameters:
      certificationId - The certification entity ID
      taskUid - When invoking this method from an inbox (workflow) context, supply the external task ID; otherwise, supply null
      Returns:
      The configuration set in the certification at instantiation
      Throws:
      CertificationServiceException - In case of server error
      See Also:

    • getListOfUDFAttributes

      Map<String,Object> getListOfUDFAttributes(Long certificationId, String taskUid)
      Returns the UDF details for User and Catalog
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      Returns:
      a User UDF attributes and Catalog UDF attributes

    • getTaskTitle

      String getTaskTitle(Long certificationId, String taskUid)
      Get the title for a task with given identification key/task uid
      Parameters:
      certificationId - - the certification Id (for authorization)
      taskUid - - the target task ID
      Returns:
      title for the task

    • getTaskInfo

      CertificationTaskInfo getTaskInfo(Long certificationId, String taskUid) throws CertificationServiceException
      Return certification task info for the specified task
      Parameters:
      certificationId - Certification Id(for authorization)
      taskUid - the target task
      Returns:
      CertificationTaskInfo
      Throws:
      CertificationServiceException

    • getTaskInfoListByCert

      List<CertificationTaskInfo> getTaskInfoListByCert(Long certificationId, String taskUid, PaginationContext context, SearchCriteria searchCriteria) throws InvalidArgumentException, CertificationEngineException
      Return a collection of certification task info for the tasks of the specified certification
      Parameters:
      certificationId - Certification Id
      taskUid - must be null (method applies only to certification instances)
      context - PaginationContext contains paging information
      searchCriteria - contains search criteria such as sorting and filter
      Returns:
      A list of certification tasks associated with this certificationId
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationEngineException - in case of any other error

    • delegateItems

      String delegateItems(Long certificationId, String currentTaskUid, Long recipientId, SearchCriteria criteria, String comments) throws CertificationServiceException
      Returns delegate items
      Parameters:
      certificationId - - required Id of the certification
      currentTaskUid - - taskUid of the task we're looking for (or null for dashboard)
      recipientId - - recipient ID
      criteria - - search criteria indicating which objects to retrieve.
      comments - - comments for action
      Returns:
      task id of the newly created delegation task, null if no task created
      Throws:
      CertificationServiceException

    • delegateItems

      String delegateItems(Long certificationId, String taskUid, Long recipientId, List<Long> userEntityIds, List<Long> roleEntityIds, List<Long> appInstanceEntityIds, List<Long> entitlementDefinitionEntityIds, String comments) throws InvalidArgumentException, CertificationIllegalStateException, SelfCertificationException, PrimaryReviewerDelegationException, CertificationEngineException
      Delegates specified line items to a delegate reviewer during review phase one or two, creating a new certification task for the delegate reviewer. The delegation is performed in the context of the primary reviewer's certification task (inbox), and the delegated items are tagged delegated in that task. Returns null if no task is created. This can happen if all items have already been delegated.
      Parameters:
      certificationId - - certification id (required)
      taskUid - - id of the current task (required)
      recipientId - - id of the new reviewer (required)
      userEntityIds - - list of user entityIds to be delegated
      roleEntityIds - - list of role entityIds to be delegated
      appInstanceEntityIds - - list of app entityIds to be delegated
      entitlementDefinitionEntityIds - - list of entitlement ids
      comments - - action comments
      Returns:
      - task id of the newly created delegation task, null if no task created
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for delegation
      SelfCertificationException - - in case a user in certification is being delegated to the same user
      PrimaryReviewerDelegationException - - when a primary reviewer is picked as a reciepient in delegate operation
      CertificationEngineException - in case of any other error

    • unDelegateItems

      void unDelegateItems(Long certificationId, String taskUid, List<Long> userEntityIds, List<Long> roleEntityIds, List<Long> appInstanceEntityIds, List<Long> entitlementDefinitionEntityIds, String comments) throws InvalidArgumentException, CertificationIllegalStateException, CertificationEngineException
      Undelegates the specified set of line items (restores them to the primary reviewer's task) during review phase one or two. The undelegation is performed in the context of the primary reviewer's certification task (inbox).
      Parameters:
      certificationId - - certification id (required)
      taskUid - - current task Uid (required)
      userEntityIds - - user entity ids to be undelegated.
      roleEntityIds - - role entity Ids
      appInstanceEntityIds - - app instance entity ids
      entitlementDefinitionEntityIds - - entitlement entity Ids
      comments - - action comments
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for undelegation
      CertificationEngineException - in case of any other error

    • unDelegateItems

      void unDelegateItems(Long certificationId, String currentTaskUid, SearchCriteria searchCriteria, String comments) throws InvalidArgumentException, CertificationIllegalStateException, CertificationEngineException
      Undelegates the specified item (restores them to the primary reviewer's task) during review phase one or two. The undelegation is performed in the context of the primary reviewer's certification task (inbox).
      Parameters:
      certificationId - - certification id
      currentTaskUid - - current task Uid
      searchCriteria - - search criteria indicating which objects to retrieve.
      comments - - action comments
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for undelegation
      CertificationEngineException - in case of any other error

    • reassignItemsPhase1

      IdentityCertification reassignItemsPhase1(Long certificationId, String taskUid, Long recipientId, Set<Long> userEntityIds, Set<Long> roleEntityIds, Set<Long> appInstEntityIds, Set<Long> entDefnEntityIds, String comments) throws InvalidArgumentException, CertificationIllegalStateException, CertificationEngineException, SelfCertificationException
      Reassign line items to the specified reviewer during phase one, creating a new certification and marking the items in the original certification as reassigned (effectively removing them). The reassignment is performed in the context of the primary reviewer's certification task (inbox).
      Parameters:
      certificationId - - certification id (required)
      taskUid - - id of the current task (required)
      recipientId - - id of the new reviewer (required)
      userEntityIds - - list of user entityIds to be reassigned (User Cert)
      roleEntityIds - - list of role entityIds to be reassigned (Role Cert)
      appInstEntityIds - - list of app entityIds to be reassigned (AppInst Cert)
      entDefnEntityIds - - list of entitlement ids (Entitlement Cert)
      comments - - action comments
      Returns:
      The Certification containing the reassigned items
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for undelegation
      SelfCertificationException - in cases when user in user certification is being reasssigned to the same user
      CertificationEngineException - in case of any other error

    • reassignItemsPhase1

      IdentityCertification reassignItemsPhase1(Long certificationId, String currentTaskUid, Long recipientId, SearchCriteria criteria, String comments) throws InvalidArgumentException, CertificationIllegalStateException, CertificationEngineException, SelfCertificationException
      Reassign line items to the specified reviewer during phase one, creating a new certification and marking the items in the original certification as reassigned (effectively removing them). The reassignment is performed in the context of the primary reviewer's certification task (inbox).
      Parameters:
      certificationId - - certification id (required)
      currentTaskUid - - id of the current task (required)
      criteria - - search criteria of entities to apply to
      recipientId - - id of the new reviewer (required)
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for undelegation
      SelfCertificationException - in cases when user in user certification is being reasssigned to the same user
      CertificationEngineException - in case of any other error

    • reassignItemsPhase2

      String reassignItemsPhase2(Long certificationId, String taskUid, Long recipientId, Set<Long> userEntityIds, Set<Long> roleEntityIds, Set<Long> appInstanceEntityIds, Set<Long> entitlementDefinitionEntityIds, String comments) throws InvalidArgumentException, CertificationIllegalStateException, CertificationEngineException
      Reassigns line items to the specified reviewer during phase two, creating a certification task for the assignee and removing the line items from the current task. The reassignment is performed in the context of the primary reviewer's certification task (inbox).
      Parameters:
      certificationId - - certification id
      taskUid - - id of the current task
      recipientId - - id of the new reviewer
      userEntityIds - - et of user entityIds to be reassigned
      roleEntityIds - - set of role entityIds to be reassigned
      appInstanceEntityIds - - set of app entityIds to be reassigned
      entitlementDefinitionEntityIds - - set of entitlement ids
      comments - - action comments
      Returns:
      reassignmentTaskUid The task Uid of the reassigned items
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for undelegation
      CertificationEngineException - in case of any other error

    • reassignItemsPhase2

      String reassignItemsPhase2(Long certificationId, String taskUid, Long recipientId, SearchCriteria criteria, String comments) throws InvalidArgumentException, CertificationIllegalStateException, CertificationEngineException
      Reassigns line items to the specified reviewer during phase two, creating a certification task for the assignee and removing the line items from the current task. The reassignment is performed in the context of the primary reviewer's certification task (inbox).
      Parameters:
      certificationId - - certification id
      taskUid - - id of the current task
      recipientId - - id of the new reviewer
      criteria - - SearchCriteria
      comments - - action comments
      Returns:
      reassignmentTaskUid The task Uid of the reassigned items
      Throws:
      InvalidArgumentException - in case some argument specifies a non-existant entity
      CertificationIllegalStateException - in case the certification or certification task are not in valid states or phases for undelegation
      CertificationEngineException - in case of any other error

    • getPhase

      Integer getPhase(Long certificationId, String taskUid)
      Returns the phase for a certification (taskUid==null) or the phase for a task associated with the certification(taskUid!=null).
      Parameters:
      certificationId - - Certification Id
      taskUid - - id of the task
      Returns:
      one of the following values in CertificationConstants: public static final Integer STATE_PHASE_1 = 11; public static final Integer STATE_PHASE_1_D = 12; public static final Integer STATE_PHASE_1_V = 13; public static final Integer STATE_PHASE_2 = 14; public static final Integer STATE_PHASE_2_D = 15; public static final Integer STATE_PHASE_2_V = 16; public static final Integer STATE_FINAL_REVIEW = 17;

    • getCertificationHistory

      List<CertificationHistory> getCertificationHistory(Long certificationId, String taskUid, CertificationConstants.EntityType entityType, Long parentId, Long childId) throws CertificationServiceException
      Returns Certification history information
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      entityType - - OIM entityType like User, Role etc for which certification history is retreive
      parentId - - parent ID for entity
      childId - - child ID for entity
      Returns:
      list of CertificationHistory objects
      Throws:
      CertificationServiceException

    • getAppInstCertificationStats

      AppInstCertificationStats getAppInstCertificationStats(Long certId, String taskUid) throws CertificationServiceException
      Retrieve AppInstCertificationStats for specified certification and task. Task is optional. Use null to get information for entire certification.
      Parameters:
      certId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      Returns:
      - AppInstCertificationStats object containing statistics for the certificaiton or task associated with the certification.
      Throws:
      CertificationServiceException

    • getIDCApplicationInstancesByBatch

      List<IDCApplicationInstance> getIDCApplicationInstancesByBatch(Long certificationId, String taskUid, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Retrieves IDCApplicationInstance objects
      Parameters:
      certificationId - - required Id of the certification to be searched
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      context - - pagination settings
      searchCriteria - - search criteria to find the data by
      Returns:
      A list of IDCApplicationInstance objects
      Throws:
      CertificationServiceException

    • getIndexForIDCApplicationInstance

      long getIndexForIDCApplicationInstance(Long certificationId, String taskUid, long appInstEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Find index in list for specified appInstId. Used by UI to step back and forth between app instances in page 1 of an Application Instance certification.
      Parameters:
      certificationId - - certification id
      taskUid - - task Uid
      appInstEntityId - - EntityId of desired app instance (from certd_app_inst.entity_id)
      context - - page context
      searchCriteria - - filter criteria
      Returns:
      Index of specified application instance Id in list of all IDCApplicationInstances matching criteria. -1L if not found.
      Throws:
      CertificationServiceException

    • getFilteredApplicationInstanceCountByCertification

      Long getFilteredApplicationInstanceCountByCertification(Long certificationId, String taskUid, SearchCriteria searchCriteria) throws CertificationServiceException
      Counts instances of IDCApplicationInstance objects for a given search, ref. getIDCApplicationInstancesByBatch(Long, String, PaginationContext, SearchCriteria)
      Parameters:
      certificationId - - required Id of the certification to be searched
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      searchCriteria - - search criteria to find the data by
      Returns:
      The number of IDCApplicationInstance objects matching
      Throws:
      CertificationServiceException

    • loadBatchApplicationInstanceAccounts

      List<IDCAccountAttributeWrapper> loadBatchApplicationInstanceAccounts(Long certificationId, String taskUid, Long applicationInstanceEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Loads accounts and attribute values for a given certification, application instance and filter
      Parameters:
      certificationId - - required Id of the certification to be searched
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      applicationInstanceEntityId - - EntityId of the application instance we're interested in
      context - - pagination settings
      searchCriteria - - search criteria to find the data by
      Returns:
      A list of IDCAccountAttributeWrapper objects
      Throws:
      CertificationServiceException

    • getFilteredAccountAttributeValueCountByCertification

      Long getFilteredAccountAttributeValueCountByCertification(Long certificationId, String taskUid, Long applicationInstanceEntityId, SearchCriteria searchCriteria) throws CertificationServiceException
      Counts accounts and attribute values for a given search, ref. loadBatchApplicationInstanceAccounts(Long, String, Long, PaginationContext, SearchCriteria)
      Parameters:
      certificationId - - required Id of the certification to be searched
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      applicationInstanceEntityId - - EntityId of the application instance we're interested in
      searchCriteria - - search criteria to find the data by
      Returns:
      The number of accounts matching
      Throws:
      CertificationServiceException

    • updateApplicationInstanceCertificationComments

      void updateApplicationInstanceCertificationComments(Long certificationId, String taskUid, Set<Long> applicationEntityIds, String comments) throws CertificationServiceException
      Update the comments for all specified entities
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      applicationEntityIds - - application instances identified by entity id
      comments - - the comments to set
      Throws:
      CertificationServiceException

    • updateApplicationInstanceCertificationComments

      void updateApplicationInstanceCertificationComments(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Update the comments for all specified entities
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      searchCriteria - - search criteria to find the application instances to change by
      comments - - the comments to set
      Throws:
      CertificationServiceException

    • certifyRemainingApplicationInstanceContent

      void certifyRemainingApplicationInstanceContent(Long certificationId, String taskUid, Set<Long> applicationEntityIds, String comments) throws CertificationServiceException
      Claims application instances and certifies associated content
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      applicationEntityIds - - application instances identified by entity id
      comments - - the comments to set
      Throws:
      CertificationServiceException

    • certifyRemainingApplicationInstanceContent

      void certifyRemainingApplicationInstanceContent(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Claims application instances and certifies associated content
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      searchCriteria - - search criteria to find the application instances to change by
      comments - - the comments to set
      Throws:
      CertificationServiceException

    • certifyRemainingApplicationInstanceContentWithOptions

      void certifyRemainingApplicationInstanceContentWithOptions(Long certificationId, String taskUid, Set<Long> applicationEntityIds, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Claims application instances and certifies associated content
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      applicationEntityIds - - application instances identified by entity id
      comments - - the comments to set
      Throws:
      CertificationServiceException

    • certifyRemainingApplicationInstanceContentWithOptions

      void certifyRemainingApplicationInstanceContentWithOptions(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Claims application instances and certifies associated content
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      searchCriteria - - search criteria to find the application instances to change by
      comments - - the comments to set
      Throws:
      CertificationServiceException

    • certifyApplicationInstances

      void certifyApplicationInstances(Long certificationId, String taskUid, Integer status, Set<Long> applicationEntityIds, String comments) throws CertificationServiceException
      Takes a decision on an application instance in the context of an application instance certification.
      Parameters:
      certificationId - - certification id
      taskUid - - taskUid to scope by or null
      status - - the status to set
      applicationEntityIds - - the applicaiton instances to work on identified by entity ids
      comments - - certification comments
      Throws:
      CertificationServiceException

    • certifyApplicationInstances

      void certifyApplicationInstances(Long certificationId, String taskUid, Integer status, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Takes a decision on an application instance in the context of an application instance certification.
      Parameters:
      certificationId - - certification id
      taskUid - - taskUid to scope by or null
      status - - the status to set
      searchCriteria - - search criteria to find the application instances to change by
      comments - - certification comments
      Throws:
      CertificationServiceException

    • certifyApplicationInstanceEntitlements

      void certifyApplicationInstanceEntitlements(Long certificationId, String taskUid, Long appInstEntityId, Set<Long> accountEntityIds, Set<Long> entAsgnEntityIds, Integer decision, Date endDate, String comments) throws CertificationServiceException
      Take a decision action on specified accounts and entitlement assignments in an Application Instance certification. Possible decisions are: Certify, Certify Conditional, Revoke, Abstain
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity id of the application instance
      accountEntityIds - - Set of account entity Ids
      entAsgnEntityIds - - Set of entitlement assignment entity Ids
      decision - - Decision: Certify, Certify Conditional, Revoke, Abstain
      endDate - - If Certify Conditional this is the expiration date
      comments - - Comments (if any) provided along with the decision
      Throws:
      CertificationServiceException

    • certifyApplicationInstanceEntitlements

      void certifyApplicationInstanceEntitlements(Long certificationId, String taskUid, Long appInstEntityId, SearchCriteria searchCriteria, Integer decision, Date endDate, String comments) throws CertificationServiceException
      Take a decision action on specified accounts and entitlement assignments in an Application Instance certification. Possible decisions are: Certify, Certify Conditional, Revoke, Abstain
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity id of the application instance
      searchCriteria - - search criteria to find the application instances to change by
      decision - - Decision: Certify, Certify Conditional, Revoke, Abstain
      endDate - - If Certify Conditional this is the expiration date
      comments - - Comments (if any) provided along with the decision
      Throws:
      CertificationServiceException

    • certifyApplicationInstanceEntitlementsWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyApplicationInstanceEntitlementsWithExistingComments(Long certificationId, String taskUid, Long appInstEntityId, Set<Long> accountEntityIds, Set<Long> entAsgnEntityIds, Integer decision, Date endDate) throws CertificationServiceException
      Take a decision action on specified accounts and entitlement assignments in an Application Instance certification using existing comments. Possible decisions are: Certify, Certify Conditional, Revoke, Abstain
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity id of the application instance
      accountEntityIds - - Set of account entity Ids
      entAsgnEntityIds - - Set of entitlement assignment entity Ids
      decision - - Decision: Certify, Certify Conditional, Revoke, Abstain
      endDate - - If Certify Conditional this is the expiration date
      Returns:
      The subset of line items for which certify operation failed with existing comments
      Throws:
      CertificationServiceException

    • certifyApplicationInstanceEntitlementsWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyApplicationInstanceEntitlementsWithExistingComments(Long certificationId, String taskUid, Long appInstEntityId, SearchCriteria searchCriteria, Integer decision, Date endDate) throws CertificationServiceException
      Take a decision action on specified accounts and entitlement assignments in an Application Instance certification using existing comments. Possible decisions are: Certify, Certify Conditional, Revoke, Abstain
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity id of the application instance
      searchCriteria - - search criteria to find the application instances to change by
      decision - - Decision: Certify, Certify Conditional, Revoke, Abstain
      endDate - - If Certify Conditional this is the expiration date
      Returns:
      The subset of line items for which certify operation failed with existing comments
      Throws:
      CertificationServiceException

    • certifyApplicationInstanceEntitlementsWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyApplicationInstanceEntitlementsWithUpdateComments(Long certificationId, String taskUid, Long appInstEntityId, Set<Long> accountEntityIds, Set<Long> entAsgnEntityIds, Integer decision, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Take a decision action on specified accounts and entitlement assignments in an Application Instance certification using provided comment if existing comment is empty. Possible decisions are: Certify, Certify Conditional, Revoke, Abstain
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity id of the application instance
      accountEntityIds - - Set of account entity Ids
      entAsgnEntityIds - - Set of entitlement assignment entity Ids
      decision - - Decision: Certify, Certify Conditional, Revoke, Abstain
      endDate - - If Certify Conditional this is the expiration date
      comments - - Comments (if any) provided along with the decision
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • certifyApplicationInstanceEntitlementsWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyApplicationInstanceEntitlementsWithUpdateComments(Long certificationId, String taskUid, Long appInstEntityId, SearchCriteria searchCriteria, Integer decision, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Take a decision action on specified accounts and entitlement assignments in an Application Instance certification using provided comment if existing comment is empty. Possible decisions are: Certify, Certify Conditional, Revoke, Abstain
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity id of the application instance
      searchCriteria - - search criteria to find the application instances to change by
      decision - - Decision: Certify, Certify Conditional, Revoke, Abstain
      endDate - - If Certify Conditional this is the expiration date
      comments - - Comments (if any) provided along with the decision
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateApplicationInstanceEntitlementComments

      void updateApplicationInstanceEntitlementComments(Long certificationId, String taskUid, Long appInstEntityId, Set<Long> accountEntityIds, Set<Long> entAsgnEntityIds, String comments) throws CertificationServiceException
      Update comments associated with a decision action on specified accounts and entitlement assignments in an Application Instance certification.
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity Id of the application instance
      accountEntityIds - - Set of account entity Ids
      entAsgnEntityIds - - Set of entitlement assignment entity Ids
      comments - - Comments associated with decision action
      Throws:
      CertificationServiceException

    • updateApplicationInstanceEntitlementComments

      void updateApplicationInstanceEntitlementComments(Long certificationId, String taskUid, Long appInstEntityId, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Update comments associated with a decision action on specified accounts and entitlement assignments in an Application Instance certification.
      Parameters:
      certificationId - - Id of the certification
      taskUid - - Uid of the task from which action is initiated, will be null if from dashboard
      appInstEntityId - - Entity Id of the application instance
      searchCriteria - - search criteria to find the application instances to change by
      comments - - Comments associated with decision action
      Throws:
      CertificationServiceException

    • getRoleCertificationStats

      RoleCertificationStats getRoleCertificationStats(Long certId, String taskUid) throws CertificationServiceException
      Retrieve RoleCertificationStats for specified certification and task. Task is optional. Use null to get information for entire certification.
      Parameters:
      certId - - Certification ID
      taskUid - - Task UID
      Returns:
      - RoleCertificationStats object containing statistics for the certificaiton or task associated with the certification.
      Throws:
      CertificationServiceException

    • getRoleMembersByBatch

      List<IDCRoleUser> getRoleMembersByBatch(Long certificationId, String taskUid, Long roleEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the list of role members for a given role in given certification or task
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      context - - Pagination Context
      searchCriteria - - Filter parameters
      Returns:
      List of role members
      Throws:
      CertificationServiceException

    • getRolePolicyEntitlementsByBatch

      List<IDCPolicyAttributeWrapper> getRolePolicyEntitlementsByBatch(Long certificationId, String taskUid, Long roleEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the combined list of policies and entitlements for a given role in given certificaiton or task
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      context - - Pagination Context
      searchCriteria - - Filter parameters
      Returns:
      Combined list of policies and entitlements
      Throws:
      CertificationServiceException

    • getRoleMemberCount

      Long getRoleMemberCount(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the count for role members in a role included in given certification or task
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      Returns:
      No of members
      Throws:
      CertificationServiceException

    • getRolePolicyEntitlementCount

      Long getRolePolicyEntitlementCount(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the count for policies and entitlements in a role included in given certification or task
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      Returns:
      No of combined policies and entitlements
      Throws:
      CertificationServiceException

    • updateRoleMemberStatusWithFilter

      void updateRoleMemberStatusWithFilter(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, Integer status, Date endDate, String comments) throws CertificationServiceException
      Updates the status of a role member
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • updateRoleMemberCommentsWithFilter

      void updateRoleMemberCommentsWithFilter(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Updates the review comments for a given role member
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • updateSelectedRoleMemberStatus

      void updateSelectedRoleMemberStatus(Long certificationId, String taskUid, Long roleEntityId, Set<Long> userEntityIds, Integer status, Date endDate, String comments) throws CertificationServiceException
      Updates the status for given list of members Ids
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      userEntityIds - - List of member entity Ids
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • updateSelectedRoleMemberComments

      void updateSelectedRoleMemberComments(Long certificationId, String taskUid, Long roleEntityId, Set<Long> userEntityIds, String comments) throws CertificationServiceException
      Updates the review comments for given list of member Ids
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      userEntityIds - - List of member entity Ids
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • updateSelectedRoleMemberStatusWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> updateSelectedRoleMemberStatusWithExistingComments(Long certificationId, String taskUid, Long roleEntityId, Set<Long> userEntityIds, Integer status, Date endDate) throws CertificationServiceException
      Updates the status for given list of members Ids
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      userEntityIds - - List of member entity Ids
      status - - New status
      endDate - - Status end date if certifying conditionally
      Returns:
      The subset of line items for which certify operation failed.
      Throws:
      CertificationServiceException

    • updateSelectedRoleMemberStatusWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> updateSelectedRoleMemberStatusWithUpdateComments(Long certificationId, String taskUid, Long roleEntityId, Set<Long> userEntityIds, Integer status, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Updates the status for given list of members Ids
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      userEntityIds - - List of member entity Ids
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed.
      Throws:
      CertificationServiceException

    • updateFilteredRoleMemberStatusWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> updateFilteredRoleMemberStatusWithExistingComments(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, Integer status, Date endDate) throws CertificationServiceException
      Updates the status of a role member
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      status - - New status
      endDate - - Status end date if certifying conditionally
      Returns:
      The subset of line items for which certify operation failed.
      Throws:
      CertificationServiceException

    • updateFilteredRoleMemberStatusWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> updateFilteredRoleMemberStatusWithUpdateComments(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, Integer status, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Updates the status of a role member
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateSelectedRolePolicyStatusWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> updateSelectedRolePolicyStatusWithExistingComments(Long certificationId, String taskUid, Long roleEntityId, Set<Long> policyEntityIds, Set<Long> attributeValueEntityIds, Integer status, Date endDate) throws CertificationServiceException
      Updates the status of a selected role policies
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      policyEntityIds - - Policy entity Ids
      attributeValueEntityIds - - Policy attribute value entity Ids
      status - - New status
      endDate - - Status end date if certifying conditionally
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateSelectedRolePolicyStatusWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> updateSelectedRolePolicyStatusWithUpdateComments(Long certificationId, String taskUid, Long roleEntityId, Set<Long> policyEntityIds, Set<Long> attributeValueEntityIds, Integer status, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Updates the status of a selected role policies
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      policyEntityIds - - Policy entity Ids
      attributeValueEntityIds - - Policy attribute value entity Ids
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateFilteredRolePolicyStatusWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> updateFilteredRolePolicyStatusWithExistingComments(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, Integer status, Date endDate) throws CertificationServiceException
      Updates the status of a role policy
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      status - - New status
      endDate - - Status end date if certifying conditionally
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateFilteredRolePolicyStatusWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> updateFilteredRolePolicyStatusWithUpdateComments(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, Integer status, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Updates the status of a role policy
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateRolePolicyStatusWithFilter

      void updateRolePolicyStatusWithFilter(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, Integer status, Date endDate, String comments) throws CertificationServiceException
      Updates the status of a role policy
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • updateRolePolicyCommentsWithFilter

      void updateRolePolicyCommentsWithFilter(Long certificationId, String taskUid, Long roleEntityId, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Updates the certification comments of a role policy
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      searchCriteria - - Filter parameters
      comments - - New status
      Throws:
      CertificationServiceException

    • updateSelectedRolePolicyStatus

      void updateSelectedRolePolicyStatus(Long certificationId, String taskUid, Long roleEntityId, Set<Long> policyEntityIds, Set<Long> attributeValueEntityIds, Integer status, Date endDate, String comments) throws CertificationServiceException
      Updates the status of a selected role policies
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      policyEntityIds - - Policy entity Ids
      attributeValueEntityIds - - Policy attribute value entity Ids
      status - - New status
      endDate - - Status end date if certifying conditionally
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • updateSelectedRolePolicyComments

      void updateSelectedRolePolicyComments(Long certificationId, String taskUid, Long roleEntityId, Set<Long> policyEntityIds, Set<Long> attributeValueEntityIds, String comments) throws CertificationServiceException
      Updates the certification comments of a selected role policies
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleEntityId - - Role Entity Id
      policyEntityIds - - Policy Ids
      attributeValueEntityIds - - Policy attribute value entity Ids
      comments - - Comments from reviewer
      Throws:
      CertificationServiceException

    • getIndexForIDCRole

      long getIndexForIDCRole(Long certificationId, String taskUid, long roleEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Find index in list for specified roleId. Used by UI to step back and forth between roles in page 1 of a role certification.
      Parameters:
      certificationId - - certification id
      taskUid - - task Uid
      roleEntityId - - EntityId of desired role (from certd_role.entity_id)
      context - - page context
      searchCriteria - - filter criteria
      Returns:
      Index of specified role Id in list of all IDCRoles matching criteria. -1L if not found.
      Throws:
      CertificationServiceException

    • getIDCRolesByBatch

      List<IDCRole> getIDCRolesByBatch(Long certificationId, String taskUid, PaginationContext context, SearchCriteria criteria) throws CertificationServiceException
      fetches a set of roles in a role certification.
      Parameters:
      certificationId - - id of certification
      taskUid - - uid of the task, can be null if called from Dashboard ui
      context -
      criteria - - search criteria
      Returns:
      list of IDCRole objects
      Throws:
      CertificationServiceException

    • getFilteredRoleCountByCertification

      Long getFilteredRoleCountByCertification(Long certificationId, String taskUid, SearchCriteria criteria)
      returns filtered role count in a role certification within a certification task.
      Parameters:
      certificationId - - certification id
      taskUid - - uid of the current task, can be null
      criteria - - filter parameters if any
      Returns:
      count of roles in a given task

    • certifyRoles

      void certifyRoles(Long certificationId, String taskUid, List<Long> roleEntityIds, Integer certified, String comments) throws CertificationServiceException
      Allows claim, revoke and abstain actions on roles within a given task. Claim action implies that the role belongs to the reviewer and it will not certify any of the role contents. Revoke and Abstain actions affect the role contents.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid, can be null
      roleEntityIds - - list of role entity ids
      certified - - reviewer decision
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyRoles

      void certifyRoles(Long certificationId, String taskUid, SearchCriteria criteria, Integer certified, String comments) throws CertificationServiceException
      Allows claim, revoke and abstain actions on roles within a given task with a set of filters. Claim action implies that the role belongs to the reviewer and it will not certify any of the role contents. Revoke and Abstain actions affect the role contents.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid, can be null
      criteria - - search criteria
      certified - - reviewer decision
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingRoleContent

      void certifyRemainingRoleContent(Long certificationId, String taskUid, List<Long> roleEntityIds, String comments) throws CertificationServiceException
      certifies remaining role content in a given task.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid, can be null
      roleEntityIds - - list of role entity ids
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingRoleContent

      void certifyRemainingRoleContent(Long certificationId, String taskUid, SearchCriteria criteria, String comments) throws CertificationServiceException
      certifies remaining role content in a given task.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid, can be null
      criteria - - search criteria
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingRoleContentWithOptions

      void certifyRemainingRoleContentWithOptions(Long certificationId, String taskUid, List<Long> roleEntityIds, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      certifies remaining role content in a given task.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid, can be null
      roleEntityIds - - list of role entity ids
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingRoleContentWithOptions

      void certifyRemainingRoleContentWithOptions(Long certificationId, String taskUid, SearchCriteria criteria, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      certifies remaining role content in a given task.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid, can be null
      criteria - - search criteria
      comments - - action comments
      Throws:
      CertificationServiceException

    • updateRoleCertificationComments

      void updateRoleCertificationComments(Long certificationId, String taskUid, List<Long> roleEntityIds, String comments) throws CertificationServiceException
      updates comments on selected roles.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of current task, can be null
      roleEntityIds - - list of role entity ids
      comments - - comments to be set
      Throws:
      CertificationServiceException

    • updateRoleCertificationComments

      void updateRoleCertificationComments(Long certificationId, String taskUid, SearchCriteria criteria, String comments) throws CertificationServiceException
      updates comments on selected roles.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of current task, can be null
      criteria - - search criteria
      comments - - comments to be set
      Throws:
      CertificationServiceException

    • getUserCertificationStats

      UserCertificationStats getUserCertificationStats(Long certId, String taskUid) throws CertificationServiceException
      Retrieve UserCertificationStats for specified certification and task. Task is optional. Use null to get information for entire certification.
      Parameters:
      certId - - Certification ID
      taskUid - - Task UID
      Returns:
      - UserCertificationStats object containing statistics for the certificaiton or task associated with the certification.
      Throws:
      CertificationServiceException

    • getUserCertPhase2Progress

      double getUserCertPhase2Progress(Long certId, String taskUid, String entityType, long lineItemId) throws CertificationServiceException
      Retrieve progress (percent complete) for User cert virtual (aka rotated) line items on phase 2 page 1 for specified cert id, task uid and line item id. Result is rounded to the nearest integer.
      Parameters:
      certId - required Id of the certification
      taskUid - taskUid of the task we're looking for (or null for dashboard)
      entityType - - Type of virtual line item: Role, Entitlement, ApplicationInstance
      lineItemId - - Id of virtual line item (roleId, appInstId or entDefnId)
      Returns:
      Percent complete for virtual line item rounded to the nearest integer.
      Throws:
      CertificationServiceException

    • getUserEntitlementCount

      Long getUserEntitlementCount(Long certificationId, String taskUid, Long userId, Map<String,Object> filters) throws CertificationServiceException
      Returns the number of entitlements matching the filters for a given user in a certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task UID
      userId - - User Id
      filters - - Filters
      Returns:
      Number of entitlements matching the filters
      Throws:
      CertificationServiceException

    • getUserEntitlementCount

      Long getUserEntitlementCount(Long certificationId, String taskUid, Long userId, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the number of entitlements matching the filters for a given user in a certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task UID
      userId - - User Id
      searchCriteria - - Filters
      Returns:
      - Number of entitlements matching the filters
      Throws:
      CertificationServiceException

    • loadBatchUserEntitlementForXls

      List<IDCUserAccountAttributeAndRoleWrapper> loadBatchUserEntitlementForXls(Long certificationId, String taskUid) throws CertificationServiceException
      Get the entitlements of a user by batch for XLS
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task UID
      Returns:
      List of wrappers for user entitlements
      Throws:
      CertificationServiceException

    • loadBatchUserEntitlements

      List<IDCAccountAttributeAndRoleWrapper> loadBatchUserEntitlements(Long certificationId, String taskUid, Long userId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Get the entitlements of a user by batch
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task UID
      userId - - User Id
      context - - Pagination Context
      searchCriteria - - Filters
      Returns:
      List of wrappers for user entitlements
      Throws:
      CertificationServiceException

    • loadBatchUserEntitlements

      List<IDCAccountAttributeAndRoleWrapper> loadBatchUserEntitlements(Long certificationId, String taskUid, Long userId, PaginationContext context, Map<String,Object> params) throws CertificationServiceException
      Get the entitlements of a user by batch
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task UID
      userId - - User Id
      context - - Pagination Context
      params - - Filters
      Returns:
      List of wrappers for user entitlements
      Throws:
      CertificationServiceException

    • getUserRiskSummary

      Map<String,Map<Integer,Integer>> getUserRiskSummary(Long certificationId, String taskUid, Long userId)

    • getUserCertPh2Pg1ItemList

      List<CatalogItemWrapper> getUserCertPh2Pg1ItemList(Long certificationId, String taskUid, PaginationContext context, SearchCriteria criteria) throws CertificationServiceException
      Returns the List of CatalogItemWrapper representing the rotated view in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      context - - Pagination Context
      criteria - - Filter parameters
      Returns:
      List of CatalogItemWrapper
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg1ItemCount

      Long getUserCertPh2Pg1ItemCount(Long certificationId, String taskUid, SearchCriteria criteria) throws CertificationServiceException
      Returns the count for List of CatalogItemWrapper representing the rotated view in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      criteria - - Filter parameters
      Returns:
      List of CatalogItemWrapper
      Throws:
      CertificationServiceException

    • certifyUserCertPh2Pg1Items

      void certifyUserCertPh2Pg1Items(Long certificationId, String taskUid, Set<Long> roleIds, Set<Long> appInstanceIds, Set<Long> entitlementDefinitionIds, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify the items on Page 1 in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleIds - - Role entity Ids
      appInstanceIds - - App Instance Ids
      entitlementDefinitionIds - - Entitlement Definition Ids
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments be reviewer
      Throws:
      CertificationServiceException

    • certifyUserCertPh2Pg1Items

      void certifyUserCertPh2Pg1Items(Long certificationId, String taskUid, SearchCriteria criteria, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify the items on Page 1 in Phase 2 of User Certification by search criteria
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      criteria - - Search Criteria
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments by reviewer
      Throws:
      CertificationServiceException

    • certifyRemainingUserCertPh2Pg1ItemContent

      void certifyRemainingUserCertPh2Pg1ItemContent(Long certificationId, String taskUid, Set<Long> roleIds, Set<Long> appInstanceIds, Set<Long> entitlementDefinitionIds, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify remaining content(non-certified) for items on Page 1 in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleIds - - Role entity Ids
      appInstanceIds - - App Instance Ids
      entitlementDefinitionIds - - Entitlement Definition Ids
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments by reviewer
      Throws:
      CertificationServiceException

    • certifyRemainingUserCertPh2Pg1ItemContent

      void certifyRemainingUserCertPh2Pg1ItemContent(Long certificationId, String taskUid, SearchCriteria criteria, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify remaining content(non-certified) for items on Page 1 in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      criteria - - Search Criteria
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments by reviewer
      Throws:
      CertificationServiceException

    • certifyRemainingUserCertPh2Pg1ItemContentWithOptions

      void certifyRemainingUserCertPh2Pg1ItemContentWithOptions(Long certificationId, String taskUid, Set<Long> roleIds, Set<Long> appInstanceIds, Set<Long> entitlementDefinitionIds, Integer certified, Date statusEndDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Certify remaining content(non-certified) for items on Page 1 in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      roleIds - - Role entity Ids
      appInstanceIds - - App Instance Ids
      entitlementDefinitionIds - - Entitlement Definition Ids
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments by reviewer
      Throws:
      CertificationServiceException

    • certifyRemainingUserCertPh2Pg1ItemContentWithOptions

      void certifyRemainingUserCertPh2Pg1ItemContentWithOptions(Long certificationId, String taskUid, SearchCriteria criteria, Integer certified, Date statusEndDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Certify remaining content(non-certified) for items on Page 1 in Phase 2 of User Certification
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      criteria - - Search Criteria
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments by reviewer
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg2UserItemList

      List<IDCRoleUser> getUserCertPh2Pg2UserItemList(Long certificationId, String taskUid, Long roleId, PaginationContext context, SearchCriteria criteria) throws CertificationServiceException
      Return a list of IDC user members corresponding to the specified role id, certification id and task uid. The list of IDC users is filtered and sorted using the specified search criteria and pagination context. This method is part of TPAD rotated view phase 2 detail (page 2) processing.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      roleId - - role entity Ids
      context - - pagination context
      criteria - - search criteria indicating which objects to retrieve.
      Returns:
      List of IDC users.
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg2UserItemCount

      Long getUserCertPh2Pg2UserItemCount(Long certificationId, String taskUid, Long roleId, SearchCriteria criteria) throws CertificationServiceException
      Return a count of IDC user members corresponding to the specified role id, certification id and task uid. The list of IDC users is filtered and sorted using the specified search criteria and pagination context. This method is part of TPAD rotated view phase 2 detail (page 2) processing.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      roleId - - role entity Ids
      criteria - - search criteria indicating which objects to retrieve.
      Returns:
      Count of IDC users.
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg2AppInstanceAccountItemList

      List<IDCAccount> getUserCertPh2Pg2AppInstanceAccountItemList(Long certificationId, String taskUid, Long appInstanceId, PaginationContext context, SearchCriteria criteria) throws CertificationServiceException
      Return a List of IDC accounts corresponding to the specified application instance id, certification id and task uid. The list of IDC accounts is filtered and sorted using the specified search criteria and pagination context. This method is part of TPAD rotated view phase 2 detail (page 2) processing.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      appInstanceId - - application instance Id
      context - - pagination context
      criteria - - search criteria indicating which objects to retrieve.
      Returns:
      List of IDC accounts.
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg2AppInstanceAccountItemCount

      Long getUserCertPh2Pg2AppInstanceAccountItemCount(Long certificationId, String taskUid, Long appInstanceId, SearchCriteria criteria) throws CertificationServiceException
      Return a count of IDC accounts corresponding to the specified application instance id, certification id and task uid. The list of IDC accounts is filtered and sorted using the specified search criteria and pagination context. This method is part of TPAD rotated view phase 2 detail (page 2) processing.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      appInstanceId - - application instance Id
      criteria - - search criteria indicating which objects to retrieve.
      Returns:
      Count of IDC accounts.
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg2EntDefinitionEntAssignItemList

      List<IDCEndPointUser> getUserCertPh2Pg2EntDefinitionEntAssignItemList(Long certificationId, String taskUid, Long entDefinitionId, PaginationContext context, SearchCriteria criteria) throws CertificationServiceException
      Return a List of IDC End Point Users corresponding to the specified entitlement definition id, certification id and task uid. The list of IDC accounts is filtered and sorted using the specified search criteria and pagination context. This method is part of TPAD rotated view phase 2 detail (page 2) processing.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      entDefinitionId - - entitlement definition Id
      context - - pagination context
      criteria - - search criteria indicating which objects to retrieve.
      Returns:
      List of IDC end point users.
      Throws:
      CertificationServiceException

    • getUserCertPh2Pg2EntDefinitionEntAssignItemCount

      Long getUserCertPh2Pg2EntDefinitionEntAssignItemCount(Long certificationId, String taskUid, Long entDefinitionId, SearchCriteria criteria) throws CertificationServiceException
      Return a count of IDC End Point Users corresponding to the specified entitlement definition id, certification id and task uid. The list of IDC accounts is filtered and sorted using the specified search criteria and pagination context. This method is part of TPAD rotated view phase 2 detail (page 2) processing.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      entDefinitionId - - entitlement definition Id
      criteria - - search criteria indicating which objects to retrieve.
      Returns:
      Count of IDC end point users.
      Throws:
      CertificationServiceException

    • certifyUserCertPh2Pg2Items

      void certifyUserCertPh2Pg2Items(Long certificationId, String taskUid, Long entityId, CertificationConstants.EntityType entityType, SearchCriteria criteria, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify the items on Page 2 in Phase 2 of User Certification by search criteria
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      entityId - - Entity Id(Role id, app instance id, entitlement definition id)
      entityType - - Entity Type
      criteria - - Search Criteria
      certified - - Status
      statusEndDate - - End date for conditional certification
      comments - - Comments be reviewer
      Throws:
      CertificationServiceException

    • certifyUserCertPh2Pg2ItemsWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyUserCertPh2Pg2ItemsWithExistingComments(Long certificationId, String taskUid, Long entityId, CertificationConstants.EntityType entityType, SearchCriteria criteria, Integer certified, Date statusEndDate) throws CertificationServiceException
      Certify the items on Page 2 in Phase 2 of User Certification by search criteria with the existing comments.
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      entityId - - Entity Id(Role id, app instance id, entitlement definition id)
      entityType - - Entity Type
      criteria - - Search Criteria
      certified - - Status
      statusEndDate - - End date for conditional certification
      Throws:
      CertificationServiceException

    • getIndexForIDCUser

      long getIndexForIDCUser(Long certificationId, String taskUid, long userId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Find index in list for specified userId. Used by UI to step back and forth between users in page 1 of a user certification.
      Parameters:
      certificationId - - certification id
      taskUid - - task Uid
      userId - - Id of desired user (from certs_user.id)
      context - - page context
      searchCriteria - - filter criteria
      Returns:
      Index of specified user Id in list of all IDCUsers matching criteria. -1L if not found.
      Throws:
      CertificationServiceException

    • getIDCUsersByBatch

      List<IDCUser> getIDCUsersByBatch(Long certificationId, String taskUid, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      gets a batch of IDC User objects within a certification task.
      Parameters:
      certificationId - - certification id
      taskUid - - task Uid
      context - - page context
      searchCriteria - - filter criteria
      Throws:
      CertificationServiceException

    • getFilteredUserCountByCertification

      Long getFilteredUserCountByCertification(Long certificationId, String taskUid, SearchCriteria searchCriteria) throws CertificationServiceException
      gets count of users in a task for user certification.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of current task,can be null if invoked from the dashboard UI
      searchCriteria - - filter parameters
      Returns:
      - count of users in that task
      Throws:
      CertificationServiceException

    • certifyUsers

      void certifyUsers(Long certificationId, String taskUid, List<Long> userEntityIds, Integer certified, String certificationComments) throws CertificationServiceException
      Allows claim, revoke and abstain actions on selected users within a given task. Claim action implies that the user works for the reviewer and it will not certify any of the user access. Revoke and Abstain actions affect the user access.
      Parameters:
      certificationId - - certification id
      taskUid - - task id
      userEntityIds - - entity ids from IDCUser objects ( returned from getIDCUsersByBatch )
      certified - - action to be taken.
      certificationComments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingUserContent

      void certifyRemainingUserContent(Long certificationId, String taskUid, List<Long> userEntityIds, String certificationComments) throws CertificationServiceException
      certifies user roles,accounts and account-attributes which are not acted on.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      userEntityIds - - user entity ids
      certificationComments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingUserContentWithOptions

      void certifyRemainingUserContentWithOptions(Long certificationId, String taskUid, List<Long> userEntityIds, String certificationComments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      certifies user roles,accounts and account-attributes which are not acted on.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      userEntityIds - - user entity ids
      certificationComments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingUserContentWithOptions

      void certifyRemainingUserContentWithOptions(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      certifies remaining user content with filters.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      searchCriteria - - search criteria indicating which objects to retrieve.
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyUsers

      void certifyUsers(Long certificationId, String taskUid, SearchCriteria sc, Integer certified, String comments) throws CertificationServiceException
      Allows claim, revoke and abstain actions on selected users within a given task with a set of filters. Claim action implies that the user works for the reviewer and it will not certify any of the user access. Revoke and Abstain actions affect the user access.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      sc - - search criteria indicating which objects to retrieve.
      certified - - action to taken
      comments - - action comments
      Throws:
      CertificationServiceException

    • revokeUsersAccess

      void revokeUsersAccess(Long certificationId, String taskUid, List<Long> userEntityIds, String certificationComments) throws CertificationServiceException
      Allows Revoke action on the access of selected users within a given task.
      Parameters:
      certificationId - - certification id
      taskUid - - task id
      userEntityIds - - entity ids from IDCUser objects ( returned from getIDCUsersByBatch )
      certificationComments - - action comments
      Throws:
      CertificationServiceException

    • revokeUsersAccess

      void revokeUsersAccess(Long certificationId, String taskUid, SearchCriteria sc, String comments) throws CertificationServiceException
      Allows Revoke action on the access of selected users within a given task with a set of filters.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      sc - - search criteria indicating which objects to retrieve.
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyRemainingUserContent

      void certifyRemainingUserContent(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      certifies remaining user content with filters.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      searchCriteria - - search criteria indicating which objects to retrieve.
      comments - - action comments
      Throws:
      CertificationServiceException

    • updateUserCertificationComments

      void updateUserCertificationComments(Long certificationId, String taskUid, List<Long> userEntityIds, String comments) throws CertificationServiceException
      updates user comments for a given list of user entity ids.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      userEntityIds - - user entity ids
      comments - - action comments
      Throws:
      CertificationServiceException

    • updateUserCertificationComments

      void updateUserCertificationComments(Long certificationId, String taskUid, SearchCriteria criteria, String comments) throws CertificationServiceException
      updates user comments which meet a specific filter criteria.
      Parameters:
      certificationId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      criteria - - search criteria indicating which objects to retrieve
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyUserEntitlements

      void certifyUserEntitlements(Long certId, String taskUid, Long userEntityId, Set<Long> roleEntityIds, Set<Long> accountEntityIds, Set<Long> accountAttributeEntityIds, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify the user entitlements for a user in User Certification
      Parameters:
      certId - - Certification Id
      taskUid - - Task UID
      userEntityId - - User Entity Id
      roleEntityIds - - Entity Ids of roles to be certified
      accountEntityIds - - Entity Ids of accounts to be certified
      accountAttributeEntityIds - - Entity Ids of account entitlements to be certified
      certified - - New certification status
      statusEndDate - - Status end date if applicable
      comments - - Certificaiton comments
      Throws:
      CertificationServiceException

    • certifyUserEntitlements

      void certifyUserEntitlements(Long certId, String taskUid, Long userEntityId, SearchCriteria criteria, Integer certified, Date statusEndDate, String comments) throws CertificationServiceException
      Certify the user entitlements for a user in User Certification
      Parameters:
      certId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      userEntityId - - user entity Id
      criteria - - search criteria indicating which objects to retrieve
      certified - - new Certification status
      statusEndDate - - Status end date if applicable
      comments - - action comments
      Throws:
      CertificationServiceException

    • certifyUserEntitlementsWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyUserEntitlementsWithExistingComments(Long certId, String taskUid, Long userEntityId, Set<Long> roleEntityIds, Set<Long> accountEntityIds, Set<Long> accountAttributeEntityIds, Integer certified, Date statusEndDate) throws CertificationServiceException
      Certify the user entitlements for a user in User Certification with existing comments
      Parameters:
      certId - - Certification Id
      taskUid - - Task UID
      userEntityId - - User Entity Id
      roleEntityIds - - Entity Ids of roles to be certified
      accountEntityIds - - Entity Ids of accounts to be certified
      accountAttributeEntityIds - - Entity Ids of account entitlements to be certified
      certified - - New certification status
      statusEndDate - - Status end date if applicable
      Returns:
      The subset of line items for which certify operation failed with existing comments
      Throws:
      CertificationServiceException

    • certifyUserEntitlementsWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyUserEntitlementsWithExistingComments(Long certId, String taskUid, Long userEntityId, SearchCriteria criteria, Integer certified, Date statusEndDate) throws CertificationServiceException
      Certify the user entitlements for a user in User Certification using existing comments
      Parameters:
      certId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      userEntityId - - user entity Id
      criteria - - search criteria indicating which objects to retrieve
      certified - - new Certification status
      statusEndDate - - Status end date if applicable
      Returns:
      The subset of line items for which certify operation failed with existing comments
      Throws:
      CertificationServiceException

    • certifyUserEntitlementsWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyUserEntitlementsWithUpdateComments(Long certId, String taskUid, Long userEntityId, Set<Long> roleEntityIds, Set<Long> accountEntityIds, Set<Long> accountAttributeEntityIds, String comments, Boolean updateOnlyEmptyComments, Integer certified, Date statusEndDate) throws CertificationServiceException
      Certify the user entitlements for a user in User Certification with new comments if existing comment is empty
      Parameters:
      certId - - Certification Id
      taskUid - - Task UID
      userEntityId - - User Entity Id
      roleEntityIds - - Entity Ids of roles to be certified
      accountEntityIds - - Entity Ids of accounts to be certified
      accountAttributeEntityIds - - Entity Ids of account entitlements to be certified
      comments - - Certification comments
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      certified - - New certification status
      statusEndDate - - Status end date if applicable
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • certifyUserEntitlementsWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> certifyUserEntitlementsWithUpdateComments(Long certId, String taskUid, Long userEntityId, SearchCriteria criteria, String comments, Boolean updateOnlyEmptyComments, Integer certified, Date statusEndDate) throws CertificationServiceException
      Certify the user entitlements for a user in User Certification using new comments if existing comment is empty
      Parameters:
      certId - - required Id of the certification
      taskUid - - taskUid of the task we're looking for (or null for dashboard)
      userEntityId - - user entity Id
      criteria - - search criteria indicating which objects to retrieve
      comments - - Certification Comments
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      certified - - new Certification status
      statusEndDate - - Status end date if applicable
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • approveUserEntitlements

      void approveUserEntitlements(Long certId, String taskUid, Long userEntityId, Set<Long> roleEntityIds, Set<Long> accountEntityIds, Set<Long> accountAttributeEntityIds, Date statusEndDate) throws CertificationServiceException
      Approve user entitlements for user in User Certification. Uses the phase one decsion and comments as the phase two decision and values.
      Parameters:
      certId - - Certification id
      taskUid - - task uid
      userEntityId - - user entity id
      roleEntityIds - - role entity id list
      accountEntityIds - - account entity id list
      accountAttributeEntityIds - - account attribute value entiy id list
      statusEndDate - - status end date
      Throws:
      CertificationServiceException

    • approveUserEntitlements

      void approveUserEntitlements(Long certId, String taskUid, Long entityId, CertificationConstants.EntityType entityType, SearchCriteria criteria, Date statusEndDate) throws CertificationServiceException
      Approve user entitlements for user in User Certification with criteria. Uses the phase one decsion and comments as the phase two decision and values.
      Parameters:
      certId - - Certification id
      taskUid - - task uid
      entityId - - Entity Id(Role/app instance/entitlement definition id from phase 2 page 1)
      entityType - - Entity Type
      criteria - - Search Criteria
      statusEndDate - - status end date
      Throws:
      CertificationServiceException

    • updateUserEntitlementComments

      void updateUserEntitlementComments(Long certId, String taskUid, Long userEntityId, Set<Long> roleEntityIds, Set<Long> accountEntityIds, Set<Long> accountAttributeEntityIds, String comments) throws CertificationServiceException
      Update the user entitlement comments for a user in User Certification
      Parameters:
      certId - - Certification Id
      userEntityId - - User Entity Id
      taskUid - - Task UID
      roleEntityIds - - Entity Ids of roles to be certified
      accountEntityIds - - Entity Ids of accounts to be certified
      accountAttributeEntityIds - - Entity Ids of account entitlements to be certified
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • updateUserEntitlementComments

      void updateUserEntitlementComments(Long certId, String taskUid, Long userEntityId, SearchCriteria criteria, String comments) throws CertificationServiceException
      Update all user entitlement comments for a user in User Certification based on search criteria
      Parameters:
      certId - - Certification Id
      userEntityId - - User Entity Id
      taskUid - - Task UID
      criteria - - SearchCriteria for all the entitlements displayed in UI
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • getEntitlementCertificationStats

      EntitlementCertificationStats getEntitlementCertificationStats(Long certId, String taskUid) throws CertificationServiceException
      Retrieve AppInstCertificationStats for specified certification and task. Task is optional. Use null to get information for entire certification.
      Parameters:
      certId - - Certification ID
      taskUid - - Task UID
      Returns:
      - AppInstCertificationStats object containing statistics for the certificaiton or task associated with the certification.
      Throws:
      CertificationServiceException

    • getIDCEntitlementsByBatch

      List<IDCEndPointAttributeValue> getIDCEntitlementsByBatch(Long certificationId, String taskUid, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      returns entitlement batch applying specified filter criteria.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      context - - supplies rows to fetch, rows to skip
      searchCriteria - - set of filters
      Returns:
      - batch of entitlements
      Throws:
      CertificationServiceException

    • getIndexForIDCEntitlement

      long getIndexForIDCEntitlement(Long certificationId, String taskUid, long entDefnEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Find index in list for specified entDefnId. Used by UI to step back and forth between entDefns in page 1 of an Entitlement certification.
      Parameters:
      certificationId - - certification id
      taskUid - - task Uid
      entDefnEntityId - - EntityId of desired ent defn (from certd_ent_defn.entity_id)
      context - - page context
      searchCriteria - - filter criteria
      Returns:
      Index of specified entitlement definition Id in list of all IDCEntitlements matching criteria. -1L if not found.
      Throws:
      CertificationServiceException

    • getEntitlementCount

      Long getEntitlementCount(Long certificationId, String taskUid, SearchCriteria searchCriteria)
      returns entitlement count applying specified filter criteria.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      searchCriteria - - set of filters
      Returns:
      count of entitlements

    • certifyEntitlements

      void certifyEntitlements(Long certificationId, String taskUid, Integer belongsToMe, Set<Long> entityIds, String comments) throws CertificationServiceException
      certifies a set of entitlements
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      belongsToMe - - page1 status value
      entityIds - - entitlements to be certified
      comments - - comments if any
      Throws:
      CertificationServiceException

    • certifyEntitlements

      void certifyEntitlements(Long certificationId, String taskUid, Integer belongsToMe, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      certifies a set of entitlements matching a search criteria.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      belongsToMe - - page1 status value
      searchCriteria - - search criteria
      comments - - comments if any
      Throws:
      CertificationServiceException

    • certifyRemainingEntitlementContent

      void certifyRemainingEntitlementContent(Long certificationId, String taskUid, Set<Long> entityIds, String comments) throws CertificationServiceException
      completes an entitlement. sets all *untouched* page2 entities to STATUS_CERTIFIED.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      entityIds - - entitlements to be certified
      comments - - comments if any
      Throws:
      CertificationServiceException

    • certifyRemainingEntitlementContent

      void certifyRemainingEntitlementContent(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      completes a set of entitlements that match a search criteria. sets all *untouched* page2 entities to STATUS_CERTIFIED.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      searchCriteria - - search criteria
      comments - - comments if any
      Throws:
      CertificationServiceException

    • certifyRemainingEntitlementContentWithOptions

      void certifyRemainingEntitlementContentWithOptions(Long certificationId, String taskUid, Set<Long> entityIds, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      completes an entitlement. sets all *untouched* page2 entities to STATUS_CERTIFIED.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      entityIds - - entitlements to be certified
      comments - - comments if any
      Throws:
      CertificationServiceException

    • certifyRemainingEntitlementContentWithOptions

      void certifyRemainingEntitlementContentWithOptions(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      completes a set of entitlements that match a search criteria. sets all *untouched* page2 entities to STATUS_CERTIFIED.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      searchCriteria - - search criteria
      comments - - comments if any
      Throws:
      CertificationServiceException

    • updateEntitlementCertificationComments

      void updateEntitlementCertificationComments(Long certificationId, String taskUid, Set<Long> entityIds, String comments) throws CertificationServiceException
      update entitlement comments for a given set of entitlements.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      entityIds - - entitlements to be updated with new comments
      comments - - comments if any
      Throws:
      CertificationServiceException

    • updateEntitlementCertificationComments

      void updateEntitlementCertificationComments(Long certificationId, String taskUid, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      update entitlement comments for entitlements matching search criteria.
      Parameters:
      certificationId - - certification id
      taskUid - - task uid of the current task, null if invoked from dashboard
      searchCriteria - - entitlements to be updated with new comments
      comments - - comments if any
      Throws:
      CertificationServiceException

    • getIDCEndPointUsersByBatch

      @Deprecated List<IDCEndPointUser> getIDCEndPointUsersByBatch(Long certificationId, String taskUid, Long attributeValueEntityId, PaginationContext context, Map<String,Object> filters) throws CertificationServiceException
      Deprecated.
      use getIDCEndPointUsersByBatch(Long, String, Long, PaginationContext, SearchCriteria)
      Throws:
      CertificationServiceException

    • getIDCEndPointUsersByBatch

      List<IDCEndPointUser> getIDCEndPointUsersByBatch(Long certificationId, String taskUid, Long attributeValueEntityId, PaginationContext context, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the list of user accounts for the given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      context - - Pagination Context
      searchCriteria - - search criteria
      Returns:
      List of IDCEndPointUser
      Throws:
      CertificationServiceException

    • getAttributeValueUsersCountWithFilter

      @Deprecated Long getAttributeValueUsersCountWithFilter(Long certificationId, String taskUid, Long attributeValueEntityId, Map<String,Object> filters) throws CertificationServiceException
      Deprecated.
      use getAttributeValueUsersCountWithFilter(Long, String, Long, SearchCriteria)
      Throws:
      CertificationServiceException

    • getAttributeValueUsersCountWithFilter

      Long getAttributeValueUsersCountWithFilter(Long certificationId, String taskUid, Long attributeValueEntityId, SearchCriteria searchCriteria) throws CertificationServiceException
      Returns the count for user accounts in the given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      searchCriteria - - search criteria
      Returns:
      List of IDCEndPointUser
      Throws:
      CertificationServiceException

    • certifyEntitlementUsersWithFilter

      void certifyEntitlementUsersWithFilter(Long certificationId, String taskUid, Long attributeValueEntityId, Map<String,Object> filters, Integer status, Date endDate, String comments) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      filters - - Filter parameters
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • updateEntitlementUserCommentsWithFilter

      void updateEntitlementUserCommentsWithFilter(Long certificationId, String taskUid, Long attributeValueEntityId, Map<String,Object> filters, String comments) throws CertificationServiceException
      Updates the user account comments for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      filters - - Filter parameters
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • certifySelectedEntitlementUsers

      void certifySelectedEntitlementUsers(Long certificationId, String taskUid, Long attributeValueEntityId, Set<Long> entitlementUserAccountEntityIds, Integer status, Date endDate, String comments) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      entitlementUserAccountEntityIds - - User account entity Ids
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • certifySelectedEntitlementUsers

      void certifySelectedEntitlementUsers(Long certificationId, String taskUid, Long attributeValueEntityId, SearchCriteria searchCriteria, Integer status, Date endDate, String comments) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      searchCriteria - - search criteria
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • certifySelectedEntitlementUsersWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifySelectedEntitlementUsersWithExistingComments(Long certificationId, String taskUid, Long attributeValueEntityId, Set<Long> entitlementUserAccountEntityIds, Integer status, Date endDate) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition with existing comments
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      entitlementUserAccountEntityIds - - User account entity Ids
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      Returns:
      The subset of line items for which certify operation failed with existing comments
      Throws:
      CertificationServiceException

    • certifySelectedEntitlementUsersWithExistingComments

      Map<CertificationConstants.EntityType,Set<Long>> certifySelectedEntitlementUsersWithExistingComments(Long certificationId, String taskUid, Long attributeValueEntityId, SearchCriteria searchCriteria, Integer status, Date endDate) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      searchCriteria - - search criteria
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      Returns:
      The subset of line items for which certify operation failed with existing comments
      Throws:
      CertificationServiceException

    • certifySelectedEntitlementUsersWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> certifySelectedEntitlementUsersWithUpdateComments(Long certificationId, String taskUid, Long attributeValueEntityId, Set<Long> entitlementUserAccountEntityIds, Integer status, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      entitlementUserAccountEntityIds - - User account entity Ids
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      comments - - Certification comments
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed.
      Throws:
      CertificationServiceException

    • certifySelectedEntitlementUsersWithUpdateComments

      Map<CertificationConstants.EntityType,Set<Long>> certifySelectedEntitlementUsersWithUpdateComments(Long certificationId, String taskUid, Long attributeValueEntityId, SearchCriteria searchCriteria, Integer status, Date endDate, String comments, Boolean updateOnlyEmptyComments) throws CertificationServiceException
      Certifies the user accounts for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      searchCriteria - - search criteria
      status - - New status
      endDate - - End date if the status is ceritify conditionally
      comments - - Certification comments
      updateOnlyEmptyComments - - Use comment if existing comment is empty or replace all
      Returns:
      The subset of line items for which certify operation failed
      Throws:
      CertificationServiceException

    • updateSelectedEntitlementUserComments

      void updateSelectedEntitlementUserComments(Long certificationId, String taskUid, Long attributeValueEntityId, Set<Long> entitlementUserAccountEntityIds, String comments) throws CertificationServiceException
      Updates the user account comments for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      entitlementUserAccountEntityIds - - User account entity Ids
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • updateSelectedEntitlementUserComments

      void updateSelectedEntitlementUserComments(Long certificationId, String taskUid, Long attributeValueEntityId, SearchCriteria searchCriteria, String comments) throws CertificationServiceException
      Updates the user account comments for a given entitlement definition
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task Uid
      attributeValueEntityId - - Entitlement Definition Entity Id
      searchCriteria - - search criteria
      comments - - Certification comments
      Throws:
      CertificationServiceException

    • getLineItemActionHistory

      List<IDCActionHistory> getLineItemActionHistory(Long certificationId, String taskUid, Long lineItemEId)
      retrieves action history for a line item.
      Parameters:
      certificationId - - certification id
      taskUid - - task identifier
      lineItemEId - - entity id of line item
      Returns:
      list of IDCActionHistory objects

    • getLineItemDetailActionHistory

      @Deprecated List<IDCActionHistory> getLineItemDetailActionHistory(Long certificationId, String taskUid, Long lineItemEId, Long lineItemDetailEId, int lineItemDetailType)
      Deprecated.
      use getLineItemDetailActionHistory(Long, String, Long, Long, CertificationConstants.EntityType)
      returns action history for a line item detail (using line item and line item detail entity ids)
      Parameters:
      certificationId - - certification id
      taskUid - - task identifier
      lineItemEId - - entity id of line item
      lineItemDetailEId - - entity id of line item detail
      lineItemDetailType - - Type of the line-item-detail we're looking at. This is required because entity ids are not guaranteed to be unique across item types.
      Returns:
      list of IDCActionHistory objects

    • getLineItemDetailActionHistory

      List<IDCActionHistory> getLineItemDetailActionHistory(Long certificationId, String taskUid, Long lineItemEId, Long lineItemDetailEId, CertificationConstants.EntityType lineItemDetailType)
      returns action history for a line item detail (using line item and line item detail entity ids)
      Parameters:
      certificationId - - certification id
      taskUid - - task identifier
      lineItemEId - - entity id of line item
      lineItemDetailEId - - entity id of line item detail
      lineItemDetailType - - Type of the line-item-detail we're looking at. This is required because entity ids are not guaranteed to be unique across item types.
      Returns:
      list of IDCActionHistory objects

    • taskAcquire

      void taskAcquire(Long certificationId, String taskUid, String acquiredBy) throws CertificationServiceException
      Update primary reviewer for the certification once the group task is acquired by a reviewer User who is invoking this API must be assigned Certification Administrator or System Administrator admin role
      Parameters:
      certificationId - - Certification Id
      taskUid - - Task UID
      acquiredBy - - User Id(usr_key from USR table)
      Throws:
      CertificationServiceException