HDIV API 2.0.4

org.hdiv.state
Interface IPage

All Known Implementing Classes:
Page

public interface IPage


Method Summary
 void addState(IState state)
          Adds a new state to the page this.
 void addState(java.lang.String id, java.lang.String request)
          Adds a new state hash to the page this.
 boolean existState(java.lang.String key)
          Checks if exists a state with the given identifier key.
 java.lang.String getFlowId()
          Returns the unique id of flow.
 java.lang.String getName()
           
 java.lang.String getRandomToken()
           
 IState getState(java.lang.String key)
          Returns the state with the given identifier key from the map of states
 java.lang.String getStateHash(java.lang.String key)
          Returns the state hash with the given identifier key from the map of states
 java.util.Map getStates()
           
 void setFlowId(java.lang.String flowId)
           
 void setName(java.lang.String name)
           
 void setRandomToken(java.lang.String randomToken)
           
 

Method Detail

addState

void addState(IState state)
Adds a new state to the page this.

Parameters:
state - State that represents all the data that composes a possible request.

addState

void addState(java.lang.String id,
              java.lang.String request)
Adds a new state hash to the page this.

Parameters:
id - state identifier
state - Hash of a state that represents all the data that composes a possible request.

existState

boolean existState(java.lang.String key)
Checks if exists a state with the given identifier key.

Parameters:
key - State identifier

getState

IState getState(java.lang.String key)
Returns the state with the given identifier key from the map of states

Parameters:
key - State identifier
Returns:
IState State with the identifier key.

getStateHash

java.lang.String getStateHash(java.lang.String key)
Returns the state hash with the given identifier key from the map of states

Parameters:
key - State identifier
Returns:
String hash with the identifier key.

getName

java.lang.String getName()
Returns:
Returns the page name.

setName

void setName(java.lang.String name)
Parameters:
name - The page name to set.

getStates

java.util.Map getStates()
Returns:
Returns the page states.

getFlowId

java.lang.String getFlowId()
Returns the unique id of flow.

Returns:
the flow id

setFlowId

void setFlowId(java.lang.String flowId)
Parameters:
flowId - the flowId to set

getRandomToken

java.lang.String getRandomToken()
Returns:
the randomToken
Since:
HDIV 2.0.4

setRandomToken

void setRandomToken(java.lang.String randomToken)
Parameters:
randomToken - the randomToken to set
Since:
HDIV 2.0.4

HDIV 2.0.4

Copyright © 2008 hdiv.org. All Rights Reserved.