org.hdiv.state
Interface IState

All Known Implementing Classes:

State

public interface IState

Method Summary

void	addParameter(java.lang.String key, IParameter parameter) Adds a new parameter to the state this.
boolean	existParameter(java.lang.String key) Checks if exists a parameter with the given identifier key.
java.lang.String	getAction()
java.lang.String	getId()
java.lang.String	getPageId()
IParameter	getParameter(java.lang.String key) Returns the parameter that matches the given identifier key.
java.util.Map	getParameters()
java.util.Hashtable	getRequiredParams()
void	setAction(java.lang.String action)
void	setId(java.lang.String id)
void	setPageId(java.lang.String pageId)

Method Detail

getParameters

java.util.Map getParameters()

Returns:

Returns the parameters

addParameter

void addParameter(java.lang.String key,
                  IParameter parameter)

Adds a new parameter to the state this. If it is a required parameter parameter, it is also added to the required parameters map.

Parameters:

key - new parameter identifier

parameter - The parameter

getParameter

IParameter getParameter(java.lang.String key)

Returns the parameter that matches the given identifier key.

Parameters:

key - parameter identifier

Returns:

IParameter object that matches the given identifier key.

getAction

java.lang.String getAction()

Returns:

Returns the action asociated to state this.

setAction

void setAction(java.lang.String action)

Parameters:

action - The action to set.

getId

java.lang.String getId()

Returns:

Returns the id.

getPageId

java.lang.String getPageId()

Returns:

Returns the page identifier which the state this belongs to.

setPageId

void setPageId(java.lang.String pageId)

Parameters:

pageId - The pageId to set.

setId

void setId(java.lang.String id)

Parameters:

id - The id to set.

existParameter

boolean existParameter(java.lang.String key)

Checks if exists a parameter with the given identifier key.

Parameters:

key - parameter identifier

Returns:

True if exists a parameter with this identifier key. False otherwise.

getRequiredParams

java.util.Hashtable getRequiredParams()

Returns:

Returns required parameters map.