com.thecoderscorner.menu.remote.commands.AckStatus Enum Reference

Public Member Functions
	AckStatus (String description, int statusCode)
String	getDescription ()
int	getStatusCode ()
boolean	isError ()

Public Attributes
	VALUE_RANGE_WARNING =("Value out of range", -1)
	SUCCESS =("OK", 0)
	ID_NOT_FOUND =("ID not found", 1)
	INVALID_CREDENTIALS =("Invalid Credentials", 2)
	UNKNOWN_ERROR =("Unknown Error", 10000)

Detailed Description

An enumeration that represents all the possible status / error return codes from the remote.

Member Function Documentation

getDescription()

String com.thecoderscorner.menu.remote.commands.AckStatus.getDescription

(

)

Returns

description of this status

getStatusCode()

int com.thecoderscorner.menu.remote.commands.AckStatus.getStatusCode

(

)

Returns

the integer wire code for this status.

isError()

boolean com.thecoderscorner.menu.remote.commands.AckStatus.isError

(

)

Returns

true if the status code is an error, otherwise false.

Member Data Documentation

ID_NOT_FOUND

com.thecoderscorner.menu.remote.commands.AckStatus.ID_NOT_FOUND =("ID not found", 1)

The requested ID was not found

INVALID_CREDENTIALS

com.thecoderscorner.menu.remote.commands.AckStatus.INVALID_CREDENTIALS =("Invalid Credentials", 2)

The credentials provided were incorrect

SUCCESS

com.thecoderscorner.menu.remote.commands.AckStatus.SUCCESS =("OK", 0)

The operation was successful

UNKNOWN_ERROR

com.thecoderscorner.menu.remote.commands.AckStatus.UNKNOWN_ERROR =("Unknown Error", 10000)

There was an error that is not categorised.

VALUE_RANGE_WARNING

com.thecoderscorner.menu.remote.commands.AckStatus.VALUE_RANGE_WARNING =("Value out of range", -1)

This is a warning that the value was out of range

---

The documentation for this enum was generated from the following file:

• src/main/java/com/thecoderscorner/menu/remote/commands/AckStatus.java