oracle.iam.identity.usermgmt.vo

Class UserManagerResult

java.lang.Object

oracle.iam.identity.usermgmt.vo.UserManagerResult

All Implemented Interfaces:

java.io.Serializable

public class UserManagerResult
extends java.lang.Object
implements java.io.Serializable

The UserManagerResult class is a value object and contains the result of operation on user entity.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserManagerResult() Construct a blank UserManagerResult
UserManagerResult(java.lang.String entityId, java.lang.String status) Construct UserManagerResult with given GUID entityId and status status

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEntityId() Provides the GUID of the user the result belongs to.
java.util.HashMap	getFailedResults() Provides a Map of failed result.
java.lang.String	getRequestId()
java.lang.String	getStatus() Provides the result status of the operation.
java.util.List	getSucceededResults() Provides List of success result containing GUID of the user for which operation succeeded.
void	setFailedResults(java.util.HashMap failedResults) Sets a Map of failed result.
void	setRequestId(java.lang.String requestId)
void	setSucceededResults(java.util.List succeededResults) Set the List of success result containing GUID of the user for which operation succeeded.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserManagerResult

public UserManagerResult()

Construct a blank UserManagerResult

UserManagerResult

public UserManagerResult(java.lang.String entityId,
                         java.lang.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 Detail

getEntityId

public java.lang.String getEntityId()

Provides the GUID of the user the result belongs to.

Returns:

The GUID of the user the result belongs to.

getRequestId

public java.lang.String getRequestId()

setRequestId

public void setRequestId(java.lang.String requestId)

getStatus

public java.lang.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(java.util.HashMap 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 java.util.HashMap 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 java.util.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(java.util.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.