org.wizard4j.user
Class FlowchartResponse

java.lang.Object
  org.wizard4j.user.FlowchartResponse

public class FlowchartResponse
extends java.lang.Object

Constructor Summary

FlowchartResponse()

FlowchartResponse(org.w3c.dom.Document document)

Method Summary

void	addUserInteractionUnit(UserInteractionUnit userInteractionUnit)
java.lang.String	getErrorMessage()
int	getIndex()
java.util.List<EUserAction>	getPossibleActionList()
java.util.List<java.lang.String>	getResponseDescriptionList()
java.lang.String	getState()
java.util.List<UserInteractionUnit>	getUserInteractionUnitList()
boolean	hasFlowchartEnded()
void	setCurrentIndex(int index)
void	setErrorMessage(java.lang.String errorMessage)
void	setPossibleActionList(java.util.List<EUserAction> possibleActionList)
void	setResponseDescriptionList(java.util.List<java.lang.String> responseDescriptionList)
void	setState(java.lang.String state)
java.lang.String	toString()
java.lang.String	toXml()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FlowchartResponse

public FlowchartResponse()

FlowchartResponse

public FlowchartResponse(org.w3c.dom.Document document)
                  throws InvalidValueException

Parameters:

document -

Throws:

InvalidValueException

Method Detail

getPossibleActionList

public java.util.List<EUserAction> getPossibleActionList()

Returns:

list of allowed actions

setPossibleActionList

public void setPossibleActionList(java.util.List<EUserAction> possibleActionList)

Parameters:

possibleActionList -

addUserInteractionUnit

public void addUserInteractionUnit(UserInteractionUnit userInteractionUnit)

Parameters:

userInteractionUnit -

getErrorMessage

public java.lang.String getErrorMessage()

Returns:

error message or null if no error

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Parameters:

errorMessage -

getResponseDescriptionList

public java.util.List<java.lang.String> getResponseDescriptionList()

Returns:

list of descriptions, one for each index value.

setResponseDescriptionList

public void setResponseDescriptionList(java.util.List<java.lang.String> responseDescriptionList)

Parameters:

responseDescriptionList -

getIndex

public int getIndex()

Returns:

the index of this response

setCurrentIndex

public void setCurrentIndex(int index)

Parameters:

index -

getState

public java.lang.String getState()

Returns:

current flowchart state

setState

public void setState(java.lang.String state)

Parameters:

state -

getUserInteractionUnitList

public java.util.List<UserInteractionUnit> getUserInteractionUnitList()

Returns:

list of user interactions in this response

hasFlowchartEnded

public boolean hasFlowchartEnded()

Returns:

true if flowchart has finished

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXml

public java.lang.String toXml()

Returns:

xml description of response