org.apache.agila.engine
Interface Token

All Known Implementing Classes:

TokenImpl

public interface Token

Version:

$Id: $

Author:

Geir Magnusson Jr.

Field Summary

static int	MID
static int	POST
static int	PRE possible states for a token

Method Summary

NodeID	getCurrentNodeID() return the node ID that this token is pointing at
int	getCurrentState() Return the current state of the token - where in the node it's pointing
InstanceID	getInstanceID() return the process instance ID for which this token is associated
TokenID	getTokenID() returns the unique ID of this token
boolean	isActive() returns the active/inactive status of the token.
void	setActive(boolean active)
void	setCurrentNodeID(NodeID currentNodeID) Sets the nodeid for this token
void	setCurrentState(int currentState) Sets the current state of the token

Field Detail

PRE

static final int PRE

possible states for a token

See Also:

Constant Field Values

MID

static final int MID

See Also:

Constant Field Values

POST

static final int POST

See Also:

Constant Field Values

Method Detail

getTokenID

TokenID getTokenID()

returns the unique ID of this token

Returns:

id of the token

getInstanceID

InstanceID getInstanceID()

return the process instance ID for which this token is associated

Returns:

instance associated with this token

getCurrentNodeID

NodeID getCurrentNodeID()

return the node ID that this token is pointing at

Returns:

current node id for this token

setCurrentNodeID

void setCurrentNodeID(NodeID currentNodeID)

Sets the nodeid for this token

Parameters:

currentNodeID -

getCurrentState

int getCurrentState()

Return the current state of the token - where in the node it's pointing

Returns:

current state (PRE | MID | POST)

setCurrentState

void setCurrentState(int currentState)

Sets the current state of the token

Parameters:

currentState -

isActive

boolean isActive()

returns the active/inactive status of the token. Active means it's the current 'state pointer' for the thread of execution that it's a part of

Returns:

true if token is active for this instance, false otherwise

setActive

void setActive(boolean active)