SMILA (incubation) API documentation

org.eclipse.smila.processing
Interface WorkflowProcessor

All Known Implementing Classes:
ODEWorkflowProcessor

public interface WorkflowProcessor

Interface of WorkflowProcessors. A workflow orchestrates a set of SMILA pipelets (or other components) to process SMILA records. It may use deliberate workflow definition languages, e.g. BPEL.

Author:
jschumacher

Field Summary
static java.lang.String NAMESPACE_PROCESSOR
          namespace of SMILA BPEL process names.
 
Method Summary
 java.util.List<java.lang.String> getWorkflowNames()
          get the names of the currently active workflows.
 Id[] process(java.lang.String workflowName, Blackboard blackboard, Id[] recordIds)
          process records on Blackboard service.
 SearchMessage process(java.lang.String workflowName, Blackboard blackboard, SearchMessage query)
          process a search request on Blackboard service.
 

Field Detail

NAMESPACE_PROCESSOR

static final java.lang.String NAMESPACE_PROCESSOR
namespace of SMILA BPEL process names.

See Also:
Constant Field Values
Method Detail

process

Id[] process(java.lang.String workflowName,
             Blackboard blackboard,
             Id[] recordIds)
             throws ProcessingException
process records on Blackboard service.

Parameters:
workflowName - name of workflow to execute on Ids
blackboard - blackboard to use for processing
recordIds - Ids of records to process.
Returns:
Ids of result records.
Throws:
ProcessingException - error during processing.

process

SearchMessage process(java.lang.String workflowName,
                      Blackboard blackboard,
                      SearchMessage query)
                      throws ProcessingException
process a search request on Blackboard service.

Parameters:
workflowName - name of workflow to execute on message.
blackboard - blackboard to use for processing
query - Id of query record. The record Id list in this will be null, usually.
Returns:
Ids of effective query and result records.
Throws:
ProcessingException - error during processing.

getWorkflowNames

java.util.List<java.lang.String> getWorkflowNames()
get the names of the currently active workflows.

Returns:
names of workflows.

SMILA (incubation) API documentation