Class UserManagerResult

java.lang.Object
oracle.iam.identity.usermgmt.vo.UserManagerResult
All Implemented Interfaces:
Serializable

public class UserManagerResult extends Object implements Serializable
The UserManagerResult class is a value object and contains the result of operation on user entity.
Author:
abhimanyu seth
See Also:
  • Constructor Details

    • UserManagerResult

      public UserManagerResult()
      Construct a blank UserManagerResult
    • UserManagerResult

      public UserManagerResult(String entityId, String status)
      Construct UserManagerResult with given GUID entityId and status status
      Parameters:
      entityId - The GUID of the user
      status - The status of the result. Set status as 'COMPLETED' if the operation is successful. For bulk operation set status as 'COMPLETED' if bulk operation is successful for at least one user.
  • Method Details

    • getEntityId

      public String getEntityId()
      Provides the GUID of the user the result belongs to.
      Returns:
      The GUID of the user the result belongs to.
    • getRequestId

      public String getRequestId()
    • setRequestId

      public void setRequestId(String requestId)
    • getStatus

      public String getStatus()
      Provides the result status of the operation.
      Returns:
      The result status of the operation. The status is 'COMPLETED' if the operation is successful. For bulk operation status is 'COMPLETED' if bulk operation is successful for at least one user.
    • setFailedResults

      public void setFailedResults(HashMap<String,String> failedResults)
      Sets a Map of failed result. The map contains mapping of GUID of the user and the failure reason. The method is intended to be used for setting failure results for bulk operation.
      Parameters:
      succeededResults - A Map of failed result containing mapping of GUID of the user and the failure reason.
    • getFailedResults

      public HashMap<String,String> getFailedResults()
      Provides a Map of failed result. The map contains mapping of GUID of the user and the failure reason. The method is intended to be used for getting failure results for bulk operation.
      Returns:
      A Map of failed result containing mapping of GUID of the user and the failure reason.
    • getSucceededResults

      public List getSucceededResults()
      Provides List of success result containing GUID of the user for which operation succeeded. The method is intended to be used for getting success result for bulk operation.
      Returns:
      A List of success result containing GUID of the user for which operation succeeded.
    • setSucceededResults

      public void setSucceededResults(List succeededResults)
      Set the List of success result containing GUID of the user for which operation succeeded. The method is intended to be used for setting success result for bulk operation.
      Parameters:
      succeededResults - The List of success result containing GUID of the user for which operation succeeded.