Package org.opencastproject.workflow.handler.comments

Class CommentWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.comments.CommentWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class CommentWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

A workflow operation handler for creating, resolving and deleting comments automatically during the workflow process.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommentWorkflowOperationHandler.Operation

Nested classes/interfaces inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

AbstractWorkflowOperationHandler.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACTION
protected static final String	DESCRIPTION
protected static final String	REASON

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

asList, description, id, serviceRegistry, SOURCE_FLAVOR, SOURCE_FLAVORS, SOURCE_TAG, SOURCE_TAGS, TARGET_FLAVOR, TARGET_FLAVORS, TARGET_TAG, TARGET_TAGS

Constructor Summary

Constructors

Constructor	Description
CommentWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
void	setEventCommentService(EventCommentService eventCommentService)	Callback from the OSGi environment that will pass a reference to the workflow service upon component activation.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

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

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

Methods inherited from class java.lang.Object

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

Field Details

ACTION

protected static final String ACTION

See Also:

• Constant Field Values

DESCRIPTION

protected static final String DESCRIPTION

See Also:

• Constant Field Values

REASON

protected static final String REASON

See Also:

• Constant Field Values

Constructor Details

CommentWorkflowOperationHandler

public CommentWorkflowOperationHandler()

Method Details

start

public WorkflowOperationResult start(WorkflowInstance workflowInstance,
 JobContext context)
                              throws WorkflowOperationException

Runs the workflow operation on this 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.

Specified by:

start in interface WorkflowOperationHandler

Specified by:

start in class AbstractWorkflowOperationHandler

Parameters:

workflowInstance - the workflow instance

context - the job context

Returns:

the WorkflowOperationResult containing a potentially modified MediaPackage and whether to put the workflow instance into a wait state.

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly, and the default error handling should be invoked.

See Also:

• WorkflowOperationHandler.start(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

setEventCommentService

public void setEventCommentService(EventCommentService eventCommentService)

Callback from the OSGi environment that will pass a reference to the workflow service upon component activation.

Parameters:

eventCommentService - the workflow service

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Description copied from class: AbstractWorkflowOperationHandler

Sets the service registry. This method is here as a convenience for developers that need the registry to do job waiting.

Overrides:

setServiceRegistry in class AbstractWorkflowOperationHandler

Parameters:

serviceRegistry - the service registry