public interface OperationResult
OperationResult serves as a pattern for all Operation Events. For each specific service package, an interface must be derived from OperationResult which adds methods allowing the application to access data appropriate for that device and result.
The getResultCode
method is used by the application to retrieve the
result of the operation. The following values are defined in
OperationResult for this purpose:
NONE |
No operation is pending. This is a placeholder initialization value for pre-created events. |
SUCCESS |
The operation was completed successfully. |
CANCEL |
The operation was externally cancelled; the operation was not completed. |
ERR_GENERAL_ERROR |
A catastrophic error has occurred during an asynchronous operation, preventing even the security rights from being tested. This is the highest-priority error designation. |
ERR_NO_PERMISSION |
The requested operation is not available. This could be because the application has no permission of this operation. |
ERR_NO_INFO |
This code is used with an error event when no further information is available. This information code must be set by a service implementation if the cause of the error does not fit an error description in the service documentation. |
ERR_TIMEOUT |
The error resulted from the expiration of a timeout. |
Modifier and Type | Field and Description |
---|---|
static int |
CANCEL
The operation was externally cancelled; the operation was not completed.
|
static int |
ERR_DEVICE_BASE
The start value of device error.
|
static int |
ERR_GENERAL_ERROR
A catastrophic error has occurred during an operation, This is the
highest-priority error designation.
|
static int |
ERR_NO_INFO
Cause of error does not fit a description in the device documentation.
|
static int |
ERR_NO_PERMISSION
The requested operation is not available.
|
static int |
ERR_TIMEOUT
The error resulted from the expiration of a timeout.
|
static int |
NONE
No operation is pending.
|
static int |
SUCCESS
The operation was completed successfully.
|
Modifier and Type | Method and Description |
---|---|
int |
getResultCode()
Retrieves the result status.
|
static final int NONE
static final int SUCCESS
static final int CANCEL
static final int ERR_GENERAL_ERROR
static final int ERR_NO_PERMISSION
static final int ERR_NO_INFO
static final int ERR_TIMEOUT
static final int ERR_DEVICE_BASE