WorkflowEngineFacade (telekom-workflow-api 1.2.3 API)

```
public interface WorkflowEngineFacade
```
Provides a facade for the workflow engine. External components (web front ends, REST interfaces, ...) are obliged to use an implementation of this facade to manage workflows.

Author:

Christian Klock

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`abortWorkflowInstance(long woinRefNum)` Aborts the workflow instance with the given refNum.
`boolean`	`assignHumanTask(long woitRefNum, String user)` Assigns the given human task work item to the given user.
`void`	`createWorkflowInstance(CreateWorkflowInstance request)` Creates a new workflow instance as described by the request and sets the request's refNum field to the newly created workflow instance's refNum.
`void`	`createWorkflowInstances(List<CreateWorkflowInstance> requests)` Creates a new workflow instance for each request in the given list and sets each request's refNum field to the newly created workflow instance's refNum.
`List<WorkItemState>`	`findActiveHumanTasksByRole(String role)` Finds any active human task work item assigned to the given role.
`List<WorkItemState>`	`findActiveHumanTasksByRoleAndUser(String role, String user)` Finds any active human task work item assigned to the given role and user.
`List<WorkItemState>`	`findActiveHumanTasksByUser(String user)` Finds any active human task work item assigned to the given user.
`WorkItemState`	`findActiveWorkItemByTokenId(long woinRefNum, int tokenId)` Finds the work item of the given workflow instance that is associated with the given token.
`ExecutionErrorState`	`findExecutionError(long woinRefNum)` Finds the workflow instance's execution error or returns `null` if the instance is not in an ERROR status.
`WorkflowInstanceState`	`findWorkflowInstance(long woinRefNum, Boolean isActive)` Finds a workflow instance with the given refNum using the given hint whether the workflow instance is active.
`List<WorkflowInstanceState>`	`findWorkflowInstances(SearchWorkflowInstances request)` Finds any workflow instance that satisfied the complex search request.
`List<WorkflowInstanceState>`	`findWorkflowInstancesByLabel1(String label1, boolean activeOnly)` Finds any workflow instance with the given label1.
`List<WorkflowInstanceState>`	`findWorkflowInstancesByLabels(String label1, String label2, boolean activeOnly)` Finds any workflow instance with the given label1.
`WorkItemState`	`findWorkItem(long woitRefNum, Boolean isInstanceActive)` Finds the work item with the given refNum using the given hint describing whether the associated workflow instance is active or not.
`List<WorkItemState>`	`findWorkItems(long woinRefNum, Boolean isInstanceActive)` Returns all the given workflow instance's work items (active and non-active) using the given work items that are associated with the given hint whether the workflow instance is active or not.
`Set<String>`	`getDeployedWorkflowNames()` Returns the set of those workflow names that are currently deployed to the engine.
`Set<String>`	`getKnownWorkflowNames()` Returns the set of those workflow names that are currently deployed to the engine PLUSS the set of those workflow names that are found in the engine's database.
`Map<Long,Date>`	`getNextActiveTimerDueDates(List<Long> woinRefNums)` Finds the next active timer work item's due date for every workflow instance in given list.
`Set<Long>`	`getWorkflowInstancesWithActiveHumanTask(List<Long> woinRefNums)` Finds those workflow instances that are currently waiting for at least 1 human task to become submitted.
`Map<String,Map<WorkflowInstanceFacadeStatus,Integer>>`	`getWorkflowStatistics()` Returns a map that describes workflow statistics.
`boolean`	`isNodeInMasterRole()` Returns whether the engine deployment at hand is in the master role within its cluster.
`void`	`resumeWorkflowInstance(long woinRefNum)` Resumes the workflow instance with the given refNum.
`void`	`retryWorkflowInstance(long woinRefNum)` Retries the workflow instance's last action (that has failed).
`void`	`sendSignalByLabel1(String label1, String signal, Object argument)` Sends the signal to all matching signal work items of the any workflow instance with the given label1 using the given argument.
`void`	`sendSignalByLabels(String label1, String label2, String signal, Object argument)` Sends the signal to all matching signal work items of the any workflow instance with the given label1 and label2 using the given argument.
`void`	`sendSignalToWorkflowInstance(long woinRefNum, String signal, Object argument)` Sends the signal to all matching signal work items of the given workflow instance using the given argument.
`void`	`sendSignalToWorkItem(long woitRefNum, String signal, Object argument)` Sends the signal to the given signal work item using the given argument.
`void`	`skipTimer(long woitRefNum)` Sets the given timer work item's due date to the current date.
`void`	`submitHumanTask(long woitRefNum, Object result)` Submits the given human task work item with the given result.
`void`	`submitTask(long woitRefNum, Object result)` Submits the given task work item with the given result.
`void`	`suspendWorkflowInstance(long woinRefNum)` Suspends the workflow instance with the given refNum.

- Method Detail
  - createWorkflowInstance
```
void createWorkflowInstance(CreateWorkflowInstance request)
```
    Creates a new workflow instance as described by the request and sets the request's refNum field to the newly created workflow instance's refNum. A valid request specifies at least the workflow name. All other fields are optional.
  - createWorkflowInstances
```
void createWorkflowInstances(List<CreateWorkflowInstance> requests)
```
    Creates a new workflow instance for each request in the given list and sets each request's refNum field to the newly created workflow instance's refNum. A valid request specifies at least the workflow name. All other fields are optional.
  - abortWorkflowInstance
```
void abortWorkflowInstance(long woinRefNum)
```
    Aborts the workflow instance with the given refNum. May be only called on workflow instance's which are not in EXECUTED or ABORTED status.
  - suspendWorkflowInstance
```
void suspendWorkflowInstance(long woinRefNum)
```
    Suspends the workflow instance with the given refNum. May be only called on workflow instance in EXECUTING status.
  - resumeWorkflowInstance
```
void resumeWorkflowInstance(long woinRefNum)
```
    Resumes the workflow instance with the given refNum. May be only called on workflow instance in SUSPENDED status.
  - retryWorkflowInstance
```
void retryWorkflowInstance(long woinRefNum)
```
    Retries the workflow instance's last action (that has failed). May be only called on workflow instances in STARTING_ERROR, EXECUTING_ERROR or ABORTING_ERROR.
  - sendSignalToWorkflowInstance
```
void sendSignalToWorkflowInstance(long woinRefNum,
                                  String signal,
                                  Object argument)
```
    Sends the signal to all matching signal work items of the given workflow instance using the given argument.
  - sendSignalToWorkItem
```
void sendSignalToWorkItem(long woitRefNum,
                          String signal,
                          Object argument)
```
    Sends the signal to the given signal work item using the given argument.
  - sendSignalByLabel1
```
void sendSignalByLabel1(String label1,
                        String signal,
                        Object argument)
```
    Sends the signal to all matching signal work items of the any workflow instance with the given label1 using the given argument.
  - sendSignalByLabels
```
void sendSignalByLabels(String label1,
                        String label2,
                        String signal,
                        Object argument)
```
    Sends the signal to all matching signal work items of the any workflow instance with the given label1 and label2 using the given argument. NB! This method tests for a match in label1 and label2. I.e. a null value for label2 will be tested as label2 IS NULL.
  - skipTimer
```
void skipTimer(long woitRefNum)
```
    Sets the given timer work item's due date to the current date.
  - assignHumanTask
```
boolean assignHumanTask(long woitRefNum,
                        String user)
```
    Assigns the given human task work item to the given user.
  - submitTask
```
void submitTask(long woitRefNum,
                Object result)
```
    Submits the given task work item with the given result.
  - submitHumanTask
```
void submitHumanTask(long woitRefNum,
                     Object result)
```
    Submits the given human task work item with the given result.
  - findWorkflowInstance
```
WorkflowInstanceState findWorkflowInstance(long woinRefNum,
                                           Boolean isActive)
```
    Finds a workflow instance with the given refNum using the given hint whether the workflow instance is active. If the hint is false the workflow instance is searched in the archive table. Otherwise, it is first searched in the engine's main table and if not found there in the archive table.
  - findWorkflowInstancesByLabel1
```
List<WorkflowInstanceState> findWorkflowInstancesByLabel1(String label1,
                                                          boolean activeOnly)
```
    Finds any workflow instance with the given label1. Hereby, activeOnly determines whether or not the archive table is included in the search.
  - findWorkflowInstancesByLabels
```
List<WorkflowInstanceState> findWorkflowInstancesByLabels(String label1,
                                                          String label2,
                                                          boolean activeOnly)
```
    Finds any workflow instance with the given label1. Hereby, activeOnly determines whether or not the archive table is included in the search. NB! This method tests for a match in label1 and label2. I.e. a null value for label2 will be tested as label2 IS NULL.
  - findWorkflowInstances
```
List<WorkflowInstanceState> findWorkflowInstances(SearchWorkflowInstances request)
```
    Finds any workflow instance that satisfied the complex search request.
  - findWorkItem
```
WorkItemState findWorkItem(long woitRefNum,
                           Boolean isInstanceActive)
```
    Finds the work item with the given refNum using the given hint describing whether the associated workflow instance is active or not. If the hint is false the work item is searched in the archive table. Otherwise, it is first searched in the engine's main table and if not found there in the archive table.
  - findActiveWorkItemByTokenId
```
WorkItemState findActiveWorkItemByTokenId(long woinRefNum,
                                          int tokenId)
```
    Finds the work item of the given workflow instance that is associated with the given token. Returns null if no such work item exists.
  - findWorkItems
```
List<WorkItemState> findWorkItems(long woinRefNum,
                                  Boolean isInstanceActive)
```
    Returns all the given workflow instance's work items (active and non-active) using the given work items that are associated with the given hint whether the workflow instance is active or not. If the hint is false the work item is searched in the archive table. Otherwise, it is first searched in the engine's main table and if not found there in the archive table.
  - findActiveHumanTasksByRole
```
List<WorkItemState> findActiveHumanTasksByRole(String role)
```
    Finds any active human task work item assigned to the given role.
  - findActiveHumanTasksByUser
```
List<WorkItemState> findActiveHumanTasksByUser(String user)
```
    Finds any active human task work item assigned to the given user.
  - findActiveHumanTasksByRoleAndUser
```
List<WorkItemState> findActiveHumanTasksByRoleAndUser(String role,
                                                      String user)
```
    Finds any active human task work item assigned to the given role and user.
  - findExecutionError
```
ExecutionErrorState findExecutionError(long woinRefNum)
```
    Finds the workflow instance's execution error or returns null if the instance is not in an ERROR status.
  - getNextActiveTimerDueDates
```
Map<Long,Date> getNextActiveTimerDueDates(List<Long> woinRefNums)
```
    Finds the next active timer work item's due date for every workflow instance in given list. The maps key is the workflow instance's refNum and the value the instance's next active timer work item's due date. The map contains only entries for those workflow instances that are currently waiting for at least 1 one timer to become due.
  - getWorkflowInstancesWithActiveHumanTask
```
Set<Long> getWorkflowInstancesWithActiveHumanTask(List<Long> woinRefNums)
```
    Finds those workflow instances that are currently waiting for at least 1 human task to become submitted.
  - getDeployedWorkflowNames
```
Set<String> getDeployedWorkflowNames()
```
    Returns the set of those workflow names that are currently deployed to the engine.
  - getKnownWorkflowNames
```
Set<String> getKnownWorkflowNames()
```
    Returns the set of those workflow names that are currently deployed to the engine PLUSS the set of those workflow names that are found in the engine's database.
  - getWorkflowStatistics
```
Map<String,Map<WorkflowInstanceFacadeStatus,Integer>> getWorkflowStatistics()
```
    Returns a map that describes workflow statistics. The outer map's key is a workflow's name and the associated value is a map of that holds the number of workflow instances by status.
  - isNodeInMasterRole
```
boolean isNodeInMasterRole()
```
    Returns whether the engine deployment at hand is in the master role within its cluster.

Interface WorkflowEngineFacade

Method Summary

Method Detail

createWorkflowInstance

createWorkflowInstances

abortWorkflowInstance

suspendWorkflowInstance

resumeWorkflowInstance

retryWorkflowInstance

sendSignalToWorkflowInstance

sendSignalToWorkItem

sendSignalByLabel1

sendSignalByLabels

skipTimer

assignHumanTask

submitTask

submitHumanTask

findWorkflowInstance

findWorkflowInstancesByLabel1

findWorkflowInstancesByLabels

findWorkflowInstances

findWorkItem

findActiveWorkItemByTokenId

findWorkItems

findActiveHumanTasksByRole

findActiveHumanTasksByUser

findActiveHumanTasksByRoleAndUser

findExecutionError

getNextActiveTimerDueDates

getWorkflowInstancesWithActiveHumanTask

getDeployedWorkflowNames

getKnownWorkflowNames

getWorkflowStatistics

isNodeInMasterRole