org.gomoob.model.state

Class State

java.lang.Object

org.gomoob.model.AbstractEntity<IDT>

org.gomoob.model.AbstractEntityWithCreationDate<String>

org.gomoob.model.state.State

All Implemented Interfaces:

IEntity<String>, IEntityWithCreationDate<String>, IState

public class State
extends AbstractEntityWithCreationDate<String>
implements IState

Entity which represents a user state.

Author:

GOMOOB SARL (contact@gomoob.com)

Field Summary

Fields inherited from class org.gomoob.model.AbstractEntityWithCreationDate

creationDate

Fields inherited from class org.gomoob.model.AbstractEntity

id

Constructor Summary

Constructors

Constructor and Description
State()

Method Summary

Modifier and Type	Method and Description
String	getMessage() Gets the message, in most cases this message is empty.
org.json.JSONObject	getMetadata() Gets the generic metadata attached to this state, this is an array which can contain any keys or values.
String	getName() Gets the name of the state.
void	setMessage(String message) Sets the message, in most cases this message is empty.
void	setMetadata(org.json.JSONObject metadata) Sets the generic metadata attached to this state, this is an array which can contain any keys or values.
void	setName(String name) Sets the name of the state.

Methods inherited from class org.gomoob.model.AbstractEntityWithCreationDate

getCreationDate, setCreationDate

Methods inherited from class org.gomoob.model.AbstractEntity

get, getId, set, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gomoob.model.IEntityWithCreationDate

getCreationDate, setCreationDate

Methods inherited from interface org.gomoob.model.IEntity

get, getId, set, setId

Constructor Detail

State

public State()

Method Detail

getMessage

public String getMessage()

Gets the message, in most cases this message is empty. The message is used to describe the state or to describe the reason why this state has been created.

Specified by:

getMessage in interface IState

Returns:

the message.

getMetadata

public org.json.JSONObject getMetadata()

Gets the generic metadata attached to this state, this is an array which can contain any keys or values. This is useful to make the state usable in every application.

Specified by:

getMetadata in interface IState

Returns:

the JSON Object of metadata.

getName

public String getName()

Gets the name of the state.

Specified by:

getName in interface IState

Returns:

the name of the state.

setMessage

public void setMessage(String message)

Sets the message, in most cases this message is empty. The message is used to describe the state or to describe the reason why this state has been created.

Specified by:

setMessage in interface IState

Parameters:

message - the message.

setMetadata

public void setMetadata(org.json.JSONObject metadata)

Sets the generic metadata attached to this state, this is an array which can contain any keys or values. This is useful to make the state usable in every application.

Specified by:

setMetadata in interface IState

Parameters:

metadata - the JSON Object of metadata.

setName

public void setName(String name)

Sets the name of the state.

Specified by:

setName in interface IState

Parameters:

name - the name of the state.