ai.olami.cloudService

Class APIResponse

java.lang.Object

ai.olami.cloudService.APIResponse

public class APIResponse
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_CODE_INVALID_CONTENT
static java.lang.String	STATUS_ERROR
static java.lang.String	STATUS_OK

Constructor Summary

Constructors

Constructor and Description
APIResponse()

Method Summary

Modifier and Type	Method and Description
APIResponseData	getData() Get the response data.
int	getErrorCode()
java.lang.String	getErrorMessage()
java.lang.String	getStatus()
boolean	hasData()
boolean	hasError() Check whether the response status is OK (= STATUS_OK) or not.
boolean	ok() Check whether the response status is OK (= STATUS_OK) or not.
void	setError(int errorCode, java.lang.String errorMessage) Set as a error response.
void	setErrorCode(int errorEode) Set error code.
void	setErrorMessage(java.lang.String errorMessage) Set error message.
void	setInvalid(java.lang.String message) Set as a invalid response.
void	setJsonStringSource(java.lang.String jsonString) Set the original JSON string.
void	setStatus(java.lang.String status) Set status value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_OK

public static final java.lang.String STATUS_OK

See Also:

Constant Field Values

STATUS_ERROR

public static final java.lang.String STATUS_ERROR

See Also:

Constant Field Values

ERROR_CODE_INVALID_CONTENT

public static final int ERROR_CODE_INVALID_CONTENT

See Also:

Constant Field Values

Constructor Detail

APIResponse

public APIResponse()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setJsonStringSource

public void setJsonStringSource(java.lang.String jsonString)

Set the original JSON string. This is helpful for debugging or to get other undefined members of this JSON string. Use toString() method to get the original JSON string.

Parameters:

jsonString - - The original JSON string.

setInvalid

public void setInvalid(java.lang.String message)

Set as a invalid response.

Parameters:

message - - Error message to explain why this is an invalid result.

setError

public void setError(int errorCode,
                     java.lang.String errorMessage)

Set as a error response.

Parameters:

errorCode - - The error code.

errorMessage - - Error message.

ok

public boolean ok()

Check whether the response status is OK (= STATUS_OK) or not.

Returns:

TRUE if the response status is OK.

hasError

public boolean hasError()

Check whether the response status is OK (= STATUS_OK) or not.

Returns:

TRUE if something wrong, or FALSE if the response status is OK.

getStatus

public java.lang.String getStatus()

Returns:

Status

setStatus

public void setStatus(java.lang.String status)

Set status value.

Parameters:

status - - Status value string.

getErrorCode

public int getErrorCode()

Returns:

Error code.

setErrorCode

public void setErrorCode(int errorEode)

Set error code.

Parameters:

errorEode - - Error code.

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

Error message.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Set error message.

Parameters:

errorMessage - - Error message.

getData

public APIResponseData getData()

Get the response data. Map to the member "data" of the JSON string.

Returns:

The response data object.

hasData

public boolean hasData()

Returns:

TRUE if contains Data information.