Enum Class RequestStatus
- All Implemented Interfaces:
Serializable
,Comparable<RequestStatus>
,Constable
Defines the status code results sent on the result receiver for requests to the plugin.
Refer to the documentation of the specific request functions for more detail.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe request was not processed because the device is already processing a request from another PCC.The request was not processed because a parameter was missing or an invalid value was passed.The request was cancelled.The request did not finish processing because there was a failure communicating with the device during its execution.The request did not finish processing because there was a failure communicating with the device during its execution.The request was not processed because a permission check failed.The request was recognized but is not supported by the targetThe request failed for an unknown reason.This request is not available on the currently installed version of the ANT+ Plugins Service.The request was successful.The value sent by the plugin service was unrecognized indicating an upgrade of the PCC may be required to handle the value. -
Method Summary
Modifier and TypeMethodDescriptionint
Convert enum to equivalent int valuestatic RequestStatus
getValueFromInt
(int intValue) Convert int to equivalent enum valuestatic RequestStatus
Returns the enum constant of this class with the specified name.static RequestStatus[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SUCCESS
The request was successful. -
FAIL_CANCELLED
The request was cancelled. -
UNRECOGNIZED
The value sent by the plugin service was unrecognized indicating an upgrade of the PCC may be required to handle the value. -
FAIL_OTHER
The request failed for an unknown reason. This includes new failure reasons implemented in newer versions of the plugins. -
FAIL_ALREADY_BUSY_EXTERNAL
The request was not processed because the device is already processing a request from another PCC. Note: You can watch the device statuses ofDeviceState.PROCESSING_REQUEST
(busy) andDeviceState.TRACKING
(idle) on yourAntPluginPcc.IDeviceStateChangeReceiver
to know when to submit your request or try to submit your request again. -
FAIL_DEVICE_COMMUNICATION_FAILURE
The request did not finish processing because there was a failure communicating with the device during its execution. -
FAIL_DEVICE_TRANSMISSION_LOST
The request did not finish processing because there was a failure communicating with the device during its execution. -
FAIL_BAD_PARAMS
The request was not processed because a parameter was missing or an invalid value was passed. -
FAIL_NO_PERMISSION
The request was not processed because a permission check failed. -
FAIL_NOT_SUPPORTED
The request was recognized but is not supported by the target -
FAIL_PLUGINS_SERVICE_VERSION
This request is not available on the currently installed version of the ANT+ Plugins Service.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getIntValue
public int getIntValue()Convert enum to equivalent int value- Returns:
- integer value equivalent
-
getValueFromInt
Convert int to equivalent enum value- Parameters:
intValue
- integer to convert- Returns:
- enum value equivalent
-