Enum Class RequestStatus

java.lang.Object
java.lang.Enum<RequestStatus>
com.dsi.ant.plugins.antplus.pcc.defines.RequestStatus
All Implemented Interfaces:
Serializable, Comparable<RequestStatus>, Constable

public enum RequestStatus extends Enum<RequestStatus>
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 Details

    • SUCCESS

      public static final RequestStatus SUCCESS
      The request was successful.
    • FAIL_CANCELLED

      public static final RequestStatus FAIL_CANCELLED
      The request was cancelled.
    • UNRECOGNIZED

      public static final RequestStatus 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 RequestStatus 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 RequestStatus 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 RequestStatus 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 RequestStatus 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 RequestStatus 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 RequestStatus FAIL_NO_PERMISSION
      The request was not processed because a permission check failed.
    • FAIL_NOT_SUPPORTED

      public static final RequestStatus FAIL_NOT_SUPPORTED
      The request was recognized but is not supported by the target
    • FAIL_PLUGINS_SERVICE_VERSION

      public static final RequestStatus FAIL_PLUGINS_SERVICE_VERSION
      This request is not available on the currently installed version of the ANT+ Plugins Service.
  • Method Details

    • values

      public static RequestStatus[] 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

      public static RequestStatus valueOf(String name)
      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 name
      NullPointerException - if the argument is null
    • getIntValue

      public int getIntValue()
      Convert enum to equivalent int value
      Returns:
      integer value equivalent
    • getValueFromInt

      public static RequestStatus getValueFromInt(int intValue)
      Convert int to equivalent enum value
      Parameters:
      intValue - integer to convert
      Returns:
      enum value equivalent