ee.telekom.workflow.graph

Interface Token

All Known Implementing Classes:

TokenImpl

public interface Token

A Token points to a Node in a Graph. The set of active tokens in a GraphInstance mark the graph instance's flow state.

Method Summary

Modifier and Type	Method and Description
int	getId() Returns the token's id.
GraphInstance	getInstance() Returns the GraphInstance that this token belongs to.
Node	getNode() Returns the Node that this token is pointing to.
Token	getParent() Returns the parent token which was involved in creating this token.
boolean	isActive() Returns whether the token is active.
void	markInactive() Marks this token as inactive, in the sense that it no longer represents an active part of the workflow instance.
void	setNode(Node node) Sets the Node that the token is pointing to.

Method Detail

getId

int getId()

Returns the token's id. The id is unique among the token's in the containing graph instance.

Returns:

the token's id

getNode

Node getNode()

Returns the Node that this token is pointing to.

Returns:

the node that this token is pointing to

setNode

void setNode(Node node)

Sets the Node that the token is pointing to.

Parameters:

node - the new node to point to

getInstance

GraphInstance getInstance()

Returns the GraphInstance that this token belongs to.

Returns:

the graph instance that this token belongs to

getParent

Token getParent()

Returns the parent token which was involved in creating this token. If this node is a GraphInstance's main token (the token that begins executing at the start node), null will be returned.

Returns:

the token's parent token or null for a main token

markInactive

void markInactive()

Marks this token as inactive, in the sense that it no longer represents an active part of the workflow instance. Once a token is marked inactive, it is generally only of historical interest. A token may be marked inactive because its execution has completed or it has been cancelled.

isActive

boolean isActive()

Returns whether the token is active.

Returns:

true, if the token is active