com.simplifiedlogic.nitro.jshell.json.response

Class ServiceStatus

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.response.ServiceStatus

public class ServiceStatus
extends java.lang.Object

This class contains general Status data to be returned in JSON response to the user. Primarily meant for error handling.

Although there is an "expired" flag defined, its use is not supprted by the server currently.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_ERROR
static java.lang.String	PARAM_EXPIRED
static java.lang.String	PARAM_MESSAGE

Constructor Summary

Constructors

Constructor and Description
ServiceStatus() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
static ServiceStatus	error(java.lang.String msg) Construct a new status object with an error message.
static ServiceStatus	expired() Construct a new status object with an expired status.
boolean	getError() Get the error flag
java.lang.String	getMessage() Get the status (error) message text
boolean	isExpired() Get the expired flag
void	setError(boolean error) Set the error flag
void	setExpired(boolean expired) Set the expired flag
void	setMessage(java.lang.String message) Set the status (error) message text

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_ERROR

public static final java.lang.String PARAM_ERROR

See Also:

Constant Field Values

PARAM_MESSAGE

public static final java.lang.String PARAM_MESSAGE

See Also:

Constant Field Values

PARAM_EXPIRED

public static final java.lang.String PARAM_EXPIRED

See Also:

Constant Field Values

Constructor Detail

ServiceStatus

public ServiceStatus()

Default constructor

Method Detail

error

public static ServiceStatus error(java.lang.String msg)

Construct a new status object with an error message. This will set the error flag.

Parameters:

msg - The text of the error message

Returns:

The new ServiceStatus object

expired

public static ServiceStatus expired()

Construct a new status object with an expired status. This will set the error flag and a standard error message.

Returns:

The new ServiceStatus object

getError

public boolean getError()

Get the error flag

Returns:

The error flag

setError

public void setError(boolean error)

Set the error flag

Parameters:

error - True if an error has occurred

getMessage

public java.lang.String getMessage()

Get the status (error) message text

Returns:

The message text

setMessage

public void setMessage(java.lang.String message)

Set the status (error) message text

Parameters:

message - The message text

isExpired

public boolean isExpired()

Get the expired flag

Returns:

The expired flag

setExpired

public void setExpired(boolean expired)

Set the expired flag

Parameters:

expired - True if the session has expired