Package com.alachisoft.ncache.runtime.datasourceprovider

Class OperationResult

java.lang.Object

com.alachisoft.ncache.runtime.datasourceprovider.OperationResult

public class OperationResult
extends java.lang.Object

OperationResult contains the result of the operation that is manipulated after the Read/WriteThru Provider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationResult.Status	Status contains the Operation Status flag that is either success/Failure/FailureRetry/FailureDontRemove

Constructor Summary

Constructors

Constructor	Description
OperationResult(DataStructureWriteOperation writeDataTypeOperation, OperationResult.Status operationStatus)	OperationResult Constructor that takes WriteOptions and OperationStatus
OperationResult(DataStructureWriteOperation writeDataTypeOperation, OperationResult.Status operationStatus, java.lang.Exception exception)	OperationResult Constructor that takes WriteOptions and OperationStatus and Exception as an arguments
OperationResult(DataStructureWriteOperation writeDataTypeOperation, OperationResult.Status operationStatus, java.lang.String errorMessage)	OperationResult Constructor that takes WriteOptions and OperationStatus and errorMessage as arguments
OperationResult(WriteOperation writeOperation, OperationResult.Status operationStatus)	OperationResult Constructor that takes WriteOptions and OperationStatus.
OperationResult(WriteOperation writeOperation, OperationResult.Status operationStatus, java.lang.Exception exception)	OperationResult Constructor that takes WriteOptions and OperationStatus and Exception as an arguments
OperationResult(WriteOperation writeOperation, OperationResult.Status operationStatus, java.lang.String errorMessage)	OperationResult Constructor that takes WriteOptions and OperationStatus and errorMessage as arguments

Method Summary

Modifier and Type	Method	Description
java.lang.String	getError()	Gets the error message associated with OperationResult.
java.lang.Exception	getException()	Gets the exception associated with the OperationResult.
WriteOperationBase	getOperation()	Gets the writeoperation associated with the OperationResult.
OperationResult.Status	getOperationStatus()	Gets the status associated with the opearation result.
boolean	getUpdateInCache()	Gets a boolean value that indicates if item will be updated in cache store after write operation.
void	setError(java.lang.String value)	Sets the error message associated with OperationResult.
void	setException(java.lang.Exception value)	Sets the exception associated with the OperationResult.
void	setOperation(WriteOperationBase value)	Sets the writeoperation associated with the OperationResult.
void	setOperationStatus(OperationResult.Status value)	Sets the status associated with the opearation result.
void	setUpdateInCache(boolean value)	Sets a boolean value that specifies if item will be updated in cache store after write operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationResult

public OperationResult(WriteOperation writeOperation,
                       OperationResult.Status operationStatus)

OperationResult Constructor that takes WriteOptions and OperationStatus.

Parameters:

writeOperation - WriteOperation associated with the operation result.

operationStatus - OperationResult.Status associated with the operation result.

OperationResult

public OperationResult(WriteOperation writeOperation,
                       OperationResult.Status operationStatus,
                       java.lang.String errorMessage)

OperationResult Constructor that takes WriteOptions and OperationStatus and errorMessage as arguments

Parameters:

writeOperation - WriteOperation associated with the operation result.

operationStatus - OperationResult.Status associated with the operation result.

errorMessage - Error message about the failure of an operation

OperationResult

public OperationResult(WriteOperation writeOperation,
                       OperationResult.Status operationStatus,
                       java.lang.Exception exception)

OperationResult Constructor that takes WriteOptions and OperationStatus and Exception as an arguments

Parameters:

writeOperation - WriteOperation associated with the operation result.

operationStatus - OperationResult.Status associated with the operation result.

exception - Exception object about the failure of an Operation

OperationResult

public OperationResult(DataStructureWriteOperation writeDataTypeOperation,
                       OperationResult.Status operationStatus)

OperationResult Constructor that takes WriteOptions and OperationStatus

Parameters:

writeDataTypeOperation - DataStructureWriteOperation associated with the operation result.

operationStatus - OperationResult.Status associated with the operation result.

OperationResult

public OperationResult(DataStructureWriteOperation writeDataTypeOperation,
                       OperationResult.Status operationStatus,
                       java.lang.String errorMessage)

OperationResult Constructor that takes WriteOptions and OperationStatus and errorMessage as arguments

Parameters:

writeDataTypeOperation - DataStructureWriteOperation associated with the operation result.

operationStatus - OperationResult.Status associated with the operation result.

errorMessage - Error message about the failure of an operation

OperationResult

public OperationResult(DataStructureWriteOperation writeDataTypeOperation,
                       OperationResult.Status operationStatus,
                       java.lang.Exception exception)

OperationResult Constructor that takes WriteOptions and OperationStatus and Exception as an arguments

Parameters:

writeDataTypeOperation - DataStructureWriteOperation associated with the operation result.

operationStatus - OperationResult.Status associated with the operation result.

exception - Exception object about the failure of an Operation

Method Detail

getUpdateInCache

public final boolean getUpdateInCache()

Gets a boolean value that indicates if item will be updated in cache store after write operation.

Returns:

True if item will be updated in cache otherwise false.

setUpdateInCache

public final void setUpdateInCache(boolean value)

Sets a boolean value that specifies if item will be updated in cache store after write operation.

Parameters:

value - The boolean value to indicate whether item will be updated in cache or not.

getOperationStatus

public final OperationResult.Status getOperationStatus()

Gets the status associated with the opearation result.

Returns:

The status of the datasource write operation.

setOperationStatus

public final void setOperationStatus(OperationResult.Status value)

Sets the status associated with the opearation result.

Parameters:

value - The status of the datasource write operation.

getOperation

public final WriteOperationBase getOperation()

Gets the writeoperation associated with the OperationResult.

Returns:

The WriteOperation instance.

setOperation

public final void setOperation(WriteOperationBase value)

Sets the writeoperation associated with the OperationResult.

Parameters:

value - The WriteOperation instance.

getException

public final java.lang.Exception getException()

Gets the exception associated with the OperationResult.

Returns:

The exception instance.

setException

public final void setException(java.lang.Exception value)

Sets the exception associated with the OperationResult.

Parameters:

value - The exception instance.

getError

public final java.lang.String getError()

Gets the error message associated with OperationResult.

Returns:

The error message as string.

setError

public final void setError(java.lang.String value)

Sets the error message associated with OperationResult.

Parameters:

value - The error message as string.