org.apache.agila.services.task
Class ResponseHandlerResponse

java.lang.Object
  org.apache.agila.services.task.ResponseHandlerResponse

public class ResponseHandlerResponse
extends java.lang.Object

The ResponseHandlerResponse is the class that holds all the information necessary for a 'response handler'- for example a portlet dealing with tasks - to determine it can send a message to the message processor to continue the activity, or to return to user for more information. *

Version:

$Id: $

Author:

Geir Magnusson Jr.

Constructor Summary

ResponseHandlerResponse()

ResponseHandlerResponse(boolean ableToContinue, TokenID tokenID, java.lang.String name, java.io.Serializable data)

Method Summary

java.io.Serializable	getActivityData() Returns a 'package' of data, application specific, that will be forwarded to the activity in the context of message processing This must be serializable, but it's up to the activity what it wants to send to itself.
java.lang.String	getActivityDataName() Returns the unique name for the data.
TokenID	getTokenID() Returns tthe TokenID of the token forwarded to the message processor for processing.
boolean	isAbleToContinue() True if the activity determines that the input in a response is sufficient to continue, and the 'response handler' is then allowed to queue a message to the message process to that effect Return false if the user / client /etc must be re-presented with information and or error message
void	setAbleToContinue(boolean ableToContinue)
void	setActivityData(java.io.Serializable activityData)
void	setActivityDataName(java.lang.String activityDataName)
void	setTokenID(TokenID tokenID)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseHandlerResponse

public ResponseHandlerResponse()

ResponseHandlerResponse

public ResponseHandlerResponse(boolean ableToContinue,
                               TokenID tokenID,
                               java.lang.String name,
                               java.io.Serializable data)

Method Detail

isAbleToContinue

public boolean isAbleToContinue()

True if the activity determines that the input in a response is sufficient to continue, and the 'response handler' is then allowed to queue a message to the message process to that effect Return false if the user / client /etc must be re-presented with information and or error message

Returns:

setAbleToContinue

public void setAbleToContinue(boolean ableToContinue)

getActivityData

public java.io.Serializable getActivityData()

Returns a 'package' of data, application specific, that will be forwarded to the activity in the context of message processing This must be serializable, but it's up to the activity what it wants to send to itself.

Returns:

setActivityData

public void setActivityData(java.io.Serializable activityData)

getActivityDataName

public java.lang.String getActivityDataName()

Returns the unique name for the data. The activity data might be mixed with other app data elements in message transport and thus the activity must name the data something that it will use to fetch out of the NodeContext's app data map.

Returns:

setActivityDataName

public void setActivityDataName(java.lang.String activityDataName)

getTokenID

public TokenID getTokenID()

Returns tthe TokenID of the token forwarded to the message processor for processing.

Returns:

setTokenID

public void setTokenID(TokenID tokenID)