org.gomoob.model

Interface IState

All Superinterfaces:

IEntity<String>, IEntityWithCreationDate<String>

All Known Implementing Classes:

State

public interface IState
extends IEntityWithCreationDate<String>

Interface which represents a state.

Author:

GOMOOB SARL (contact@gomoob.com)

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 interface org.gomoob.model.IEntityWithCreationDate

getCreationDate, setCreationDate

Methods inherited from interface org.gomoob.model.IEntity

get, getId, set, setId

Method Detail

getMessage

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.

Returns:

the message.

getMetadata

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.

Returns:

the JSON Object of metadata.

getName

String getName()

Gets the name of the state.

Returns:

the name of the state.

setMessage

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.

Parameters:

message - the message.

setMetadata

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.

Parameters:

metadata - the JSON Object of metadata.

setName

void setName(String name)

Sets the name of the state.

Parameters:

name - the name of the state.