com.dsi.ant.plugins.antplus.pcc

Enum AntPlusGeocachePcc.GeocacheRequestStatus

java.lang.Object

java.lang.Enum<AntPlusGeocachePcc.GeocacheRequestStatus>

com.dsi.ant.plugins.antplus.pcc.AntPlusGeocachePcc.GeocacheRequestStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AntPlusGeocachePcc.GeocacheRequestStatus>

Enclosing class:

AntPlusGeocachePcc

public static enum AntPlusGeocachePcc.GeocacheRequestStatus
extends java.lang.Enum<AntPlusGeocachePcc.GeocacheRequestStatus>

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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL_ALREADY_BUSY_EXTERNAL The request was not processed because the device is already processing a request from another PCC.
FAIL_BAD_PARAMS The request was not processed because a parameter was missing or an invalid value was passed.
FAIL_CANCELLED The request was cancelled.
FAIL_DEVICE_COMMUNICATION_FAILURE The request did not finish processing because there was a failure communicating with the device during its execution.
FAIL_DEVICE_DATA_NOT_DOWNLOADED The request was not processed because it requires reading the current device data which is not yet downloaded.
FAIL_DEVICE_NOT_IN_LIST The request was not processed because the device is not present on the available devices list.
FAIL_DEVICE_TRANSMISSION_LOST The request did not finish processing because there was a failure communicating with the device during its execution.
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_OTHER The request failed for an unknown reason.
SUCCESS The request was successful.
UNRECOGNIZED The value sent by the plugin service was unrecognized indicating an upgrade of the PCC may be required to handle the value.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIntValue() Convert enum to equivalent int value
static AntPlusGeocachePcc.GeocacheRequestStatus	getValueFromInt(int intValue) Convert int to equivalent enum value
static AntPlusGeocachePcc.GeocacheRequestStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AntPlusGeocachePcc.GeocacheRequestStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final AntPlusGeocachePcc.GeocacheRequestStatus SUCCESS

The request was successful.

FAIL_CANCELLED

public static final AntPlusGeocachePcc.GeocacheRequestStatus FAIL_CANCELLED

The request was cancelled.

UNRECOGNIZED

public static final AntPlusGeocachePcc.GeocacheRequestStatus 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

public static final AntPlusGeocachePcc.GeocacheRequestStatus 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

public static final AntPlusGeocachePcc.GeocacheRequestStatus 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 of DeviceState.PROCESSING_REQUEST (busy) and DeviceState.TRACKING (idle) on your AntPluginPcc.IDeviceStateChangeReceiver to know when to submit your request or try to submit your request again.

FAIL_DEVICE_COMMUNICATION_FAILURE

public static final AntPlusGeocachePcc.GeocacheRequestStatus 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

public static final AntPlusGeocachePcc.GeocacheRequestStatus 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

public static final AntPlusGeocachePcc.GeocacheRequestStatus FAIL_BAD_PARAMS

The request was not processed because a parameter was missing or an invalid value was passed.

FAIL_NO_PERMISSION

public static final AntPlusGeocachePcc.GeocacheRequestStatus FAIL_NO_PERMISSION

The request was not processed because a permission check failed.

FAIL_NOT_SUPPORTED

public static final AntPlusGeocachePcc.GeocacheRequestStatus FAIL_NOT_SUPPORTED

The request was recognized but is not supported by the target

FAIL_DEVICE_NOT_IN_LIST

public static final AntPlusGeocachePcc.GeocacheRequestStatus FAIL_DEVICE_NOT_IN_LIST

The request was not processed because the device is not present on the available devices list.

FAIL_DEVICE_DATA_NOT_DOWNLOADED

public static final AntPlusGeocachePcc.GeocacheRequestStatus FAIL_DEVICE_DATA_NOT_DOWNLOADED

The request was not processed because it requires reading the current device data which is not yet downloaded. Download the device data and try again.

Method Detail

values

public static AntPlusGeocachePcc.GeocacheRequestStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AntPlusGeocachePcc.GeocacheRequestStatus c : AntPlusGeocachePcc.GeocacheRequestStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AntPlusGeocachePcc.GeocacheRequestStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getIntValue

public int getIntValue()

Convert enum to equivalent int value

Returns:

integer value equivalent

getValueFromInt

public static AntPlusGeocachePcc.GeocacheRequestStatus getValueFromInt(int intValue)

Convert int to equivalent enum value

Parameters:

intValue - integer to convert

Returns:

enum value equivalent