com.dsi.ant.plugins.internal.pluginsipc

Class RequestStatusCode

java.lang.Object

com.dsi.ant.plugins.internal.pluginsipc.RequestStatusCode

Direct Known Subclasses:

AntFsCommon.AntFsRequestStatusCode

public class RequestStatusCode
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAIL_ALREADY_BUSY_EXTERNAL The request was not processed because the device is already processing a request from another PCC.
static int	FAIL_BAD_PARAMS The request was not processed because a parameter was missing or an invalid value was passed.
static int	FAIL_CANCELLED The request was cancelled.
static int	FAIL_DEVICE_COMMUNICATION_FAILURE The request did not finish processing because there was a failure communicating with the device during its execution.
static int	FAIL_DEVICE_TRANSMISSION_LOST The request did not finish processing because there was a failure communicating with the device during its execution.
static int	FAIL_NO_PERMISSION The request was not processed because a permission check failed.
static int	FAIL_NOT_SUPPORTED The request was recognized but is not supported by the target
static int	FAIL_OTHER The request failed for an unknown reason.
static int	SUCCESS The request was successful.

Constructor Summary

Constructors

Constructor and Description
RequestStatusCode()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

The request was successful.

See Also:

Constant Field Values

FAIL_CANCELLED

public static final int FAIL_CANCELLED

The request was cancelled.

See Also:

Constant Field Values

FAIL_OTHER

public static final int FAIL_OTHER

The request failed for an unknown reason. This includes new failure reasons implemented in newer versions of the plugins.

See Also:

Constant Field Values

FAIL_ALREADY_BUSY_EXTERNAL

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

See Also:

Constant Field Values

FAIL_DEVICE_COMMUNICATION_FAILURE

public static final int FAIL_DEVICE_COMMUNICATION_FAILURE

The request did not finish processing because there was a failure communicating with the device during its execution.

See Also:

Constant Field Values

FAIL_DEVICE_TRANSMISSION_LOST

public static final int FAIL_DEVICE_TRANSMISSION_LOST

The request did not finish processing because there was a failure communicating with the device during its execution.

See Also:

Constant Field Values

FAIL_BAD_PARAMS

public static final int FAIL_BAD_PARAMS

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

See Also:

Constant Field Values

FAIL_NO_PERMISSION

public static final int FAIL_NO_PERMISSION

The request was not processed because a permission check failed.

See Also:

Constant Field Values

FAIL_NOT_SUPPORTED

public static final int FAIL_NOT_SUPPORTED

The request was recognized but is not supported by the target

See Also:

Constant Field Values

Constructor Detail

RequestStatusCode

public RequestStatusCode()