GraphInstanceImpl (telekom-workflow-engine 1.2.7 API)

java.lang.Object
- ee.telekom.workflow.graph.core.GraphInstanceImpl

All Implemented Interfaces:: GraphInstance

public class GraphInstanceImpl
extends Object
implements GraphInstance

Constructor Summary

Constructors
Constructor and Description

GraphInstanceImpl()

GraphInstanceImpl(Graph graph)

Constructors
Constructor and Description
`GraphInstanceImpl()`
`GraphInstanceImpl(Graph graph)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToExecutionQueue(Token token)` Adds a token to the execution queue.
`void`	`addToHistory(String event)` Adds the given event into the instance's history log.
`void`	`addToken(Token token)` Adds a token to the graph instance.
`void`	`addWorkItem(GraphWorkItem workItem)` When a token execution reaches a wait state, it produces a `WorkItem` which describes the work that needs to be completed in order to continue the token's execution.
`List<Token>`	`getActiveChildTokens(Token parent)` `Token`s are created with a tree-like parent-child relation-ship.
`List<Token>`	`getActiveTokens()`
`GraphWorkItem`	`getActiveWorkItem(Token token)` A token can be associated with 0 or 1 active work items.
`EnvironmentImpl`	`getEnvironment()`
`Long`	`getExternalId()` A `GraphInstance` may be assigned an external id to associate it with externally persisted state, buisness data, etc.
`Token`	`getFirstFromExecutionQueue()` A `GraphInstance` keeps a queue of tokens for which the engine should attempt to proceed execution.
`Graph`	`getGraph()`
`String`	`getHistory()` Returns the instance's history log.
`int`	`getTokenIdSequence()`
`List<Token>`	`getTokens()`
`List<GraphWorkItem>`	`getWorkItems()`
`boolean`	`isCompleted()` A `GraphInstance` is completed if it does not contain any active tokens.
`int`	`nextTokenId()` A `Token` has a graph instance specific id.
`void`	`removeFirstFromExecutionQueue()` Removes the head of the execution queue.
`void`	`setEnvironment(EnvironmentImpl environment)`
`void`	`setExternalId(Long externalId)`
`void`	`setGraph(Graph graph)`
`void`	`setHistory(String history)`
`void`	`setTokenIdSquence(int tokenIdSequence)`
`void`	`setTokens(List<Token> tokens)`
`void`	`setWorkItems(List<GraphWorkItem> workItems)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GraphInstanceImpl
```
public GraphInstanceImpl()
```
  - GraphInstanceImpl
```
public GraphInstanceImpl(Graph graph)
```
- Method Detail
  - getExternalId
```
public Long getExternalId()
```
    Description copied from interface: GraphInstance
    
    A GraphInstance may be assigned an external id to associate it with externally persisted state, buisness data, etc.
    
    Specified by:
    
    getExternalId in interface GraphInstance
    
    Returns:
    
    the graph instance's external id
  - getGraph
```
public Graph getGraph()
```
    Specified by:
    
    getGraph in interface GraphInstance
    
    Returns:
    
    the graph being executed
  - getEnvironment
```
public EnvironmentImpl getEnvironment()
```
    Specified by:
    
    getEnvironment in interface GraphInstance
    
    Returns:
    
    the graph instance's Environment
  - getTokens
```
public List<Token> getTokens()
```
    Specified by:
    
    getTokens in interface GraphInstance
    
    Returns:
    
    the list of all tokens (both active and inactive) in the graph instance
  - getActiveTokens
```
public List<Token> getActiveTokens()
```
    Specified by:
    
    getActiveTokens in interface GraphInstance
    
    Returns:
    
    the list of all active tokens in the graph instance
  - getActiveChildTokens
```
public List<Token> getActiveChildTokens(Token parent)
```
    Description copied from interface: GraphInstance
    
    Tokens are created with a tree-like parent-child relation-ship. Each token has exactly one parent and may have zero to many child tokens. Child tokens are mainly created at fork nodes which produce 1-N outgoing tokens. When a token is cancelled, all it's child tokens are cancelled as well.
    
    Specified by:
    
    getActiveChildTokens in interface GraphInstance
    
    Returns:
    
    the list of all active child tokens of the given parent token
  - addToken
```
public void addToken(Token token)
```
    Description copied from interface: GraphInstance
    
    Adds a token to the graph instance.
    
    Specified by:
    
    addToken in interface GraphInstance
    
    Parameters:
    
    token - the token to be added
  - isCompleted
```
public boolean isCompleted()
```
    Description copied from interface: GraphInstance
    
    A GraphInstance is completed if it does not contain any active tokens.
    
    Specified by:
    
    isCompleted in interface GraphInstance
    
    Returns:
    
    true, if the graph instance is completed.
  - nextTokenId
```
public int nextTokenId()
```
    Description copied from interface: GraphInstance
    
    A Token has a graph instance specific id. It is a graph instance's task to provide a sequence for such id numbers.
    
    Specified by:
    
    nextTokenId in interface GraphInstance
    
    Returns:
    
    a new token id, as used when creating a new token
  - addWorkItem
```
public void addWorkItem(GraphWorkItem workItem)
```
    Description copied from interface: GraphInstance
    
    When a token execution reaches a wait state, it produces a WorkItem which describes the work that needs to be completed in order to continue the token's execution.
    This node is not intended to be called directly from a node's Node.execute(GraphEngine, Token) method. They should rather call methods such as GraphEngine.addSignalItem(GraphInstance, Token, String) which also notify GraphWorkItemEventListeners in addition to calling this method.
    
    Specified by:
    
    addWorkItem in interface GraphInstance
    
    Parameters:
    
    workItem - the work item to be added to the instance
  - getActiveWorkItem
```
public GraphWorkItem getActiveWorkItem(Token token)
```
    Description copied from interface: GraphInstance
    
    A token can be associated with 0 or 1 active work items. A work item is considered active if its status is neither WorkItemStatus.COMPLETED nor WorkItemStatus.CANCELLED.
    
    Specified by:
    
    getActiveWorkItem in interface GraphInstance
    
    Parameters:
    
    token - the token of which to find the active work item
    
    Returns:
    
    the active work item associated with the given token or null if no such work item exists
  - setExternalId
```
public void setExternalId(Long externalId)
```
  - setGraph
```
public void setGraph(Graph graph)
```
  - setEnvironment
```
public void setEnvironment(EnvironmentImpl environment)
```
  - setTokens
```
public void setTokens(List<Token> tokens)
```
  - getTokenIdSequence
```
public int getTokenIdSequence()
```
  - setTokenIdSquence
```
public void setTokenIdSquence(int tokenIdSequence)
```
  - getWorkItems
```
public List<GraphWorkItem> getWorkItems()
```
    Specified by:
    
    getWorkItems in interface GraphInstance
    
    Returns:
    
    a list of all work items (both active and inactive) in the graph instance
  - setWorkItems
```
public void setWorkItems(List<GraphWorkItem> workItems)
```
  - addToHistory
```
public void addToHistory(String event)
```
    Description copied from interface: GraphInstance
    
    Adds the given event into the instance's history log.
    
    Specified by:
    
    addToHistory in interface GraphInstance
    
    Parameters:
    
    event - information on an execution event
  - setHistory
```
public void setHistory(String history)
```
  - getHistory
```
public String getHistory()
```
    Description copied from interface: GraphInstance
    
    Returns the instance's history log.
    
    Specified by:
    
    getHistory in interface GraphInstance
    
    Returns:
    
    the instance's history log.
  - getFirstFromExecutionQueue
```
public Token getFirstFromExecutionQueue()
```
    Description copied from interface: GraphInstance
    
    A GraphInstance keeps a queue of tokens for which the engine should attempt to proceed execution. This method peeks the top of this queue, i.e. it returns the queue's head but does not remove it.
    
    Specified by:
    
    getFirstFromExecutionQueue in interface GraphInstance
    
    Returns:
    
    the token to continue execution with or null if currently no token can be executed
  - addToExecutionQueue
```
public void addToExecutionQueue(Token token)
```
    Description copied from interface: GraphInstance
    
    Adds a token to the execution queue.
    
    Specified by:
    
    addToExecutionQueue in interface GraphInstance
    
    Parameters:
    
    token - the token to be added
  - removeFirstFromExecutionQueue
```
public void removeFirstFromExecutionQueue()
```
    Description copied from interface: GraphInstance
    
    Removes the head of the execution queue.
    
    Specified by:
    
    removeFirstFromExecutionQueue in interface GraphInstance

Class GraphInstanceImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphInstanceImpl

GraphInstanceImpl

Method Detail

getExternalId

getGraph

getEnvironment

getTokens

getActiveTokens

getActiveChildTokens

addToken

isCompleted

nextTokenId

addWorkItem

getActiveWorkItem

setExternalId

setGraph

setEnvironment

setTokens

getTokenIdSequence

setTokenIdSquence

getWorkItems

setWorkItems

addToHistory

setHistory

getHistory

getFirstFromExecutionQueue

addToExecutionQueue

removeFirstFromExecutionQueue