com.simplifiedlogic.nitro.jshell.json.response

Class BaseResponse

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.response.BaseResponse

public class BaseResponse
extends java.lang.Object

This is the common structure for all JSON responses. All requests will have this format, though some of the fields are optional. Any function-specific response values will be stored in the "data" property.

The "echoString" property is a legacy property used to pass the original JSON request string back to the client, in addition to the regular output.

Constructor Summary

Constructors

Constructor and Description
BaseResponse()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Hashtable<java.lang.String,java.lang.Object>	getData() Get the function-specific output data
java.lang.String	getEchoString() Get the string containing an echo of the original JSON request
java.lang.String	getSessionId() Get the new (replacement) session ID
ServiceStatus	getStatus() Get the status object used for error handling
void	setData(java.util.Hashtable<java.lang.String,java.lang.Object> data) Set the function-specific output data
void	setEchoString(java.lang.String echoString) Get the string containing an echo of the original JSON request
void	setSessionId(java.lang.String sessionId) Set the new (replacement session ID
void	setStatus(ServiceStatus status) Set the status object used for error handling

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseResponse

public BaseResponse()

Method Detail

getStatus

public ServiceStatus getStatus()

Get the status object used for error handling

Returns:

The status object

setStatus

public void setStatus(ServiceStatus status)

Set the status object used for error handling

Parameters:

status - The status object

getSessionId

public java.lang.String getSessionId()

Get the new (replacement) session ID

Returns:

The new session ID

setSessionId

public void setSessionId(java.lang.String sessionId)

Set the new (replacement session ID

Parameters:

sessionId - The enw session ID

getEchoString

public java.lang.String getEchoString()

Get the string containing an echo of the original JSON request

Returns:

The request as a JSON string

setEchoString

public void setEchoString(java.lang.String echoString)

Get the string containing an echo of the original JSON request

Parameters:

echoString - The request as a JSON string

getData

public java.util.Hashtable<java.lang.String,java.lang.Object> getData()

Get the function-specific output data

Returns:

The output data as a generic Hashtable object

setData

public void setData(java.util.Hashtable<java.lang.String,java.lang.Object> data)

Set the function-specific output data

Parameters:

data - The output data as a generic Hashtable object