org.opencastproject.workflow.handler.workflow

Class IncludeWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.workflow.IncludeWorkflowOperationHandler

All Implemented Interfaces:

org.opencastproject.workflow.api.WorkflowOperationHandler

public final class IncludeWorkflowOperationHandler
extends org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

Workflow operation handler that will conditionally insert a complete workflow into the current one at its own position.

Field Summary

Fields

Modifier and Type	Field and Description
static String	WORKFLOW_CFG Configuration value for the workflow operation definition

Fields inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

asList, description, id, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
IncludeWorkflowOperationHandler()

Method Summary

Modifier and Type	Method and Description
void	activate(org.osgi.service.component.ComponentContext componentContext)
void	insertWorkflow(org.opencastproject.workflow.api.WorkflowInstance wi, String workflowDefinitionId) Adds the operations found in the workflow defined by workflowDefinitionId to the workflow instance and returns true if everything worked fine, false otherwise.
void	setWorkflowService(org.opencastproject.workflow.api.WorkflowService service) OSGi DI.
org.opencastproject.workflow.api.WorkflowOperationResult	start(org.opencastproject.workflow.api.WorkflowInstance wi, org.opencastproject.job.api.JobContext context)

Methods inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

asList, cfgKeyMissing, createResult, createResult, createResult, createResult, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, hashCode, setJobBarrierPollingInterval, setServiceRegistry, skip, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

WORKFLOW_CFG

public static final String WORKFLOW_CFG

Configuration value for the workflow operation definition

See Also:

Constant Field Values

Constructor Detail

IncludeWorkflowOperationHandler

public IncludeWorkflowOperationHandler()

Method Detail

activate

public void activate(org.osgi.service.component.ComponentContext componentContext)

Overrides:

activate in class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

start

public org.opencastproject.workflow.api.WorkflowOperationResult start(org.opencastproject.workflow.api.WorkflowInstance wi,
                                                                      org.opencastproject.job.api.JobContext context)
                                                               throws org.opencastproject.workflow.api.WorkflowOperationException

Specified by:

start in interface org.opencastproject.workflow.api.WorkflowOperationHandler

Specified by:

start in class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

Throws:

org.opencastproject.workflow.api.WorkflowOperationException

insertWorkflow

public void insertWorkflow(org.opencastproject.workflow.api.WorkflowInstance wi,
                           String workflowDefinitionId)
                    throws org.opencastproject.workflow.api.WorkflowOperationException

Adds the operations found in the workflow defined by workflowDefinitionId to the workflow instance and returns true if everything worked fine, false otherwise.

Parameters:

wi - the instance to insert the workflow identified by workflowDefinitionId into

workflowDefinitionId - id of the workflow definition to insert

Throws:

org.opencastproject.workflow.api.WorkflowOperationException - in case of any error

setWorkflowService

public void setWorkflowService(org.opencastproject.workflow.api.WorkflowService service)

OSGi DI.