Package com.broadleafcommerce.orchestration.service.provider.external

Interface WorkflowProvider

All Known Implementing Classes:
ExternalWorkflowProvider
public interface WorkflowProvider
Support remote REST API calls to WorkflowServices

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    incompleteExistsByContextValue(String contextValue, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Determine if an active workflow exists for a context value
    void
    resume(String workflowId, Map<String,String> additionalWorkflowContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Request that the remote workflow service resume a paused or failed workflow execution
    void
    start(WorkflowRequest request)
    Request that the remote workflow service start a new workflow execution

  • Method Details

    • start

      void start(WorkflowRequest request)
      Request that the remote workflow service start a new workflow execution
      Parameters:
      request - Request that the remote workflow service start a new workflow execution

    • resume

      void resume(String workflowId, Map<String,String> additionalWorkflowContext, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Request that the remote workflow service resume a paused or failed workflow execution
      Parameters:
      workflowId - The id of the workflow to be resumed
      additionalWorkflowContext - Additional parameters to add to the workflow's context
      contextInfo - Context information about the multi-tenant state.

    • incompleteExistsByContextValue

      boolean incompleteExistsByContextValue(String contextValue, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Determine if an active workflow exists for a context value
      Parameters:
      contextValue - The context value to check for an active workflow
      contextInfo - The context information around multi-tenant state
      Returns:
      True if the workflow exists, false otherwise