com.thingworx.common

Enum RESTAPIConstants.StatusCode

java.lang.Object

java.lang.Enum<RESTAPIConstants.StatusCode>

com.thingworx.common.RESTAPIConstants.StatusCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RESTAPIConstants.StatusCode>

Enclosing class:

RESTAPIConstants

@ThingworxExtensionApiClass(since={6,6})
public static enum RESTAPIConstants.StatusCode
extends java.lang.Enum<RESTAPIConstants.StatusCode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
STATUS_ACCEPTED
STATUS_BAD_GATEWAY
STATUS_BAD_REQUEST
STATUS_COMM_ERROR
STATUS_COMM_TIMEOUT
STATUS_CONFLICT
STATUS_CREATED
STATUS_FORBIDDEN
STATUS_FOUND
STATUS_GATEWAY_TIMEOUT
STATUS_I_AM_A_TEAPOT
STATUS_I_AM_BUZZED
STATUS_INTERNAL_ERROR
STATUS_INVALID_PROTOCOL_VERSION
STATUS_INVALID_SESSION
STATUS_METHOD_NOT_ALLOWED
STATUS_MOVED_PERMANENTLY
STATUS_MULTIPLE_CHOICES
STATUS_NO_CONTENT
STATUS_NOT_ACCEPTABLE
STATUS_NOT_FOUND
STATUS_NOT_IMPLEMENTED
STATUS_NOT_MODIFIED
STATUS_PARTIAL_CONTENT
STATUS_PAYMENT_REQUIRED
STATUS_REQUEST_TIMEOUT
STATUS_SEE_OTHER
STATUS_SERVER_REFUSED
STATUS_SERVER_UNAVAILABLE
STATUS_SERVICE_UNAVAILABLE
STATUS_SUCCESS
STATUS_TEMPORARY_REDIRECT
STATUS_UNAUTHORIZED
STATUS_USE_PROXY

Method Summary

Modifier and Type	Method and Description
byte	binaryCode()
static RESTAPIConstants.StatusCode	fromBinaryCode(byte code)
static RESTAPIConstants.StatusCode	fromHttpCode(short code)
java.lang.String	getStatusMessage()
short	httpCode()
boolean	isError()
static RESTAPIConstants.StatusCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RESTAPIConstants.StatusCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STATUS_USE_PROXY

public static final RESTAPIConstants.StatusCode STATUS_USE_PROXY

STATUS_ACCEPTED

public static final RESTAPIConstants.StatusCode STATUS_ACCEPTED

STATUS_BAD_GATEWAY

public static final RESTAPIConstants.StatusCode STATUS_BAD_GATEWAY

STATUS_REQUEST_TIMEOUT

public static final RESTAPIConstants.StatusCode STATUS_REQUEST_TIMEOUT

STATUS_SERVER_REFUSED

public static final RESTAPIConstants.StatusCode STATUS_SERVER_REFUSED

STATUS_I_AM_A_TEAPOT

public static final RESTAPIConstants.StatusCode STATUS_I_AM_A_TEAPOT

STATUS_CONFLICT

public static final RESTAPIConstants.StatusCode STATUS_CONFLICT

STATUS_SEE_OTHER

public static final RESTAPIConstants.StatusCode STATUS_SEE_OTHER

STATUS_METHOD_NOT_ALLOWED

public static final RESTAPIConstants.StatusCode STATUS_METHOD_NOT_ALLOWED

STATUS_FOUND

public static final RESTAPIConstants.StatusCode STATUS_FOUND

STATUS_TEMPORARY_REDIRECT

public static final RESTAPIConstants.StatusCode STATUS_TEMPORARY_REDIRECT

STATUS_BAD_REQUEST

public static final RESTAPIConstants.StatusCode STATUS_BAD_REQUEST

STATUS_SERVER_UNAVAILABLE

public static final RESTAPIConstants.StatusCode STATUS_SERVER_UNAVAILABLE

STATUS_NOT_IMPLEMENTED

public static final RESTAPIConstants.StatusCode STATUS_NOT_IMPLEMENTED

STATUS_NOT_MODIFIED

public static final RESTAPIConstants.StatusCode STATUS_NOT_MODIFIED

STATUS_INVALID_SESSION

public static final RESTAPIConstants.StatusCode STATUS_INVALID_SESSION

STATUS_PAYMENT_REQUIRED

public static final RESTAPIConstants.StatusCode STATUS_PAYMENT_REQUIRED

STATUS_COMM_ERROR

public static final RESTAPIConstants.StatusCode STATUS_COMM_ERROR

STATUS_MOVED_PERMANENTLY

public static final RESTAPIConstants.StatusCode STATUS_MOVED_PERMANENTLY

STATUS_INVALID_PROTOCOL_VERSION

public static final RESTAPIConstants.StatusCode STATUS_INVALID_PROTOCOL_VERSION

STATUS_INTERNAL_ERROR

public static final RESTAPIConstants.StatusCode STATUS_INTERNAL_ERROR

STATUS_NOT_FOUND

public static final RESTAPIConstants.StatusCode STATUS_NOT_FOUND

STATUS_NOT_ACCEPTABLE

public static final RESTAPIConstants.StatusCode STATUS_NOT_ACCEPTABLE

STATUS_CREATED

public static final RESTAPIConstants.StatusCode STATUS_CREATED

STATUS_GATEWAY_TIMEOUT

public static final RESTAPIConstants.StatusCode STATUS_GATEWAY_TIMEOUT

STATUS_I_AM_BUZZED

public static final RESTAPIConstants.StatusCode STATUS_I_AM_BUZZED

STATUS_MULTIPLE_CHOICES

public static final RESTAPIConstants.StatusCode STATUS_MULTIPLE_CHOICES

STATUS_SUCCESS

public static final RESTAPIConstants.StatusCode STATUS_SUCCESS

STATUS_UNAUTHORIZED

public static final RESTAPIConstants.StatusCode STATUS_UNAUTHORIZED

STATUS_NO_CONTENT

public static final RESTAPIConstants.StatusCode STATUS_NO_CONTENT

STATUS_PARTIAL_CONTENT

public static final RESTAPIConstants.StatusCode STATUS_PARTIAL_CONTENT

STATUS_FORBIDDEN

public static final RESTAPIConstants.StatusCode STATUS_FORBIDDEN

STATUS_SERVICE_UNAVAILABLE

public static final RESTAPIConstants.StatusCode STATUS_SERVICE_UNAVAILABLE

STATUS_COMM_TIMEOUT

public static final RESTAPIConstants.StatusCode STATUS_COMM_TIMEOUT

Method Detail

values

public static RESTAPIConstants.StatusCode[] 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 (RESTAPIConstants.StatusCode c : RESTAPIConstants.StatusCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static RESTAPIConstants.StatusCode 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

httpCode

@ThingworxExtensionApiMethod(since={6,6})
public short httpCode()

binaryCode

@ThingworxExtensionApiMethod(since={6,6})
public byte binaryCode()

fromHttpCode

@ThingworxExtensionApiMethod(since={6,6})
public static RESTAPIConstants.StatusCode fromHttpCode(short code)

fromBinaryCode

@ThingworxExtensionApiMethod(since={6,6})
public static RESTAPIConstants.StatusCode fromBinaryCode(byte code)

isError

@ThingworxExtensionApiMethod(since={6,6})
public boolean isError()

getStatusMessage

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String getStatusMessage()