Package org.opencastproject.workflow.handler.workflow

Class StartWorkflowWorkflowOperationHandler

  • All Implemented Interfaces:
    org.opencastproject.workflow.api.WorkflowOperationHandler
    public class StartWorkflowWorkflowOperationHandler
extends org.opencastproject.workflow.api.AbstractWorkflowOperationHandler
    This WOH starts a new workflow for given media package.

    • Nested Class Summary

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

        org.opencastproject.workflow.api.AbstractWorkflowOperationHandler.Configuration

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String MEDIA_PACKAGE_ID
      Name of the configuration option that provides the media package ID
      static String WORKFLOW_DEFINITION
      Name of the configuration option that provides the workflow definition ID

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

        asList, description, id, serviceRegistry

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setAssetManager​(org.opencastproject.assetmanager.api.AssetManager assetManager)
      Callback for the OSGi declarative services configuration.
      void setWorkflowService​(org.opencastproject.workflow.api.WorkflowService workflowService)
      Callback for the OSGi declarative services configuration.
      org.opencastproject.workflow.api.WorkflowOperationResult start​(org.opencastproject.workflow.api.WorkflowInstance workflowInstance, org.opencastproject.job.api.JobContext context)  

      • 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, setServiceRegistry, skip, toString, waitForStatus, waitForStatus

    • Field Detail

      • MEDIA_PACKAGE_ID

        public static final String MEDIA_PACKAGE_ID
        Name of the configuration option that provides the media package ID
        See Also:
        Constant Field Values

      • WORKFLOW_DEFINITION

        public static final String WORKFLOW_DEFINITION
        Name of the configuration option that provides the workflow definition ID
        See Also:
        Constant Field Values

    • Constructor Detail

      • StartWorkflowWorkflowOperationHandler

        public StartWorkflowWorkflowOperationHandler()

    • Method Detail

      • setAssetManager

        public void setAssetManager​(org.opencastproject.assetmanager.api.AssetManager assetManager)
        Callback for the OSGi declarative services configuration.
        Parameters:
        assetManager - the asset manager

      • setWorkflowService

        public void setWorkflowService​(org.opencastproject.workflow.api.WorkflowService workflowService)
        Callback for the OSGi declarative services configuration.
        Parameters:
        workflowService - the workflow service

      • start

        public org.opencastproject.workflow.api.WorkflowOperationResult start​(org.opencastproject.workflow.api.WorkflowInstance workflowInstance,
                                                                      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