me.adaptive.arp.api

Class APIResponse

java.lang.Object

me.adaptive.arp.api.APIResponse

public class APIResponse
extends java.lang.Object

Structure representing a JSON response to the HTML5 layer.

Since:

v2.0

Constructor Summary

Constructors

Constructor and Description
APIResponse() Default constructor
APIResponse(java.lang.String response, int statusCode) Constructor with parameters.
APIResponse(java.lang.String response, int statusCode, java.lang.String statusMessage) Constructor with parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getResponse() Response getter
int	getStatusCode() Status code getter
java.lang.String	getStatusMessage() Status message getter
void	setResponse(java.lang.String response) Response setter
void	setStatusCode(int statusCode) Status code setter
void	setStatusMessage(java.lang.String statusMessage) Status message setter.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIResponse

public APIResponse()

Default constructor

Since:

v2.0

APIResponse

public APIResponse(java.lang.String response,
                   int statusCode)

Constructor with parameters.

Parameters:

response - String representing the JavaScript value or JSON object representation of the response.

statusCode - Status code of the response (200 = OK, others are warning or error conditions).

Since:

v2.0

APIResponse

public APIResponse(java.lang.String response,
                   int statusCode,
                   java.lang.String statusMessage)

Constructor with parameters.

Parameters:

response - String representing the JavaScript value or JSON object representation of the response.

statusCode - Status code of the response (200 = OK, others are warning or error conditions).

statusMessage - Status message of the response.

Method Detail

getResponse

public java.lang.String getResponse()

Response getter

Returns:

String representing the JavaScript value or JSON object representation of the response.

Since:

v2.0

setResponse

public void setResponse(java.lang.String response)

Response setter

Parameters:

response - String representing the JavaScript value or JSON object representation of the response.

getStatusCode

public int getStatusCode()

Status code getter

Returns:

Status code of the response (200 = OK, others are warning or error conditions).

setStatusCode

public void setStatusCode(int statusCode)

Status code setter

Parameters:

statusCode - Status code of the response (200 = OK, others are warning or error conditions).

getStatusMessage

public java.lang.String getStatusMessage()

Status message getter

Returns:

Status message of the response.

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

Status message setter.

Parameters:

statusMessage - Status message of the response