Package org.opencastproject.workflow.api

Interface ResumableWorkflowOperationHandler

All Superinterfaces:

WorkflowOperationHandler

All Known Implementing Classes:

ConfigureByDublinCoreTermWOH, ErrorResolutionWorkflowOperationHandler, ResumableWorkflowOperationHandlerBase, TagByDublinCoreTermWOH, VideoEditorWorkflowOperationHandler

public interface ResumableWorkflowOperationHandler
extends WorkflowOperationHandler

A WorkflowOperationHandler that is allowed to return Action.PAUSE to pause (and later resume) a workflow.

Method Summary

Modifier and Type	Method	Description
String	getHoldActionTitle()	Returns the title for the link to this operations hold state UI.
String	getHoldStateUserInterfaceURL(WorkflowInstance workflowInstance)	Gets the URL for the user interface for resuming the workflow.
boolean	isAlwaysPause()	Whether this operation handler will always pause.
WorkflowOperationResult	resume(WorkflowInstance workflowInstance, JobContext context, Map<String,String> properties)	Continues a suspended WorkflowInstance.

Methods inherited from interface org.opencastproject.workflow.api.WorkflowOperationHandler

destroy, getDescription, getId, skip, start

Method Details

resume

WorkflowOperationResult resume(WorkflowInstance workflowInstance,
 JobContext context,
 Map<String,String> properties)
                        throws WorkflowOperationException

Continues a suspended WorkflowInstance. If the execution fails for some reason, this must throw a WorkflowOperationException in order to handle the problem gracefully. Runtime exceptions will cause the entire workflow instance to fail. If the workflow instance is not in a suspended state, this method should throw an IllegalStateException.

Parameters:

workflowInstance - The workflow instance

context - the job context

properties - The properties added while the operation was on hold

Returns:

the result of this operation

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly.

isAlwaysPause

boolean isAlwaysPause()

Whether this operation handler will always pause. The workflow service may give preferential dispatching to operations that are guaranteed to pause.

Returns:

whether this handler always pauses

getHoldStateUserInterfaceURL

String getHoldStateUserInterfaceURL(WorkflowInstance workflowInstance)
                             throws WorkflowOperationException

Gets the URL for the user interface for resuming the workflow.

Parameters:

workflowInstance - The workflow instance

Returns:

The URL for the user interface

Throws:

WorkflowOperationException - If the url to the hold state ui can't be created

getHoldActionTitle

String getHoldActionTitle()

Returns the title for the link to this operations hold state UI.

Returns:

title to be displayed