Package com.day.cq.workflow

Interface PayloadMap

public interface PayloadMap
The PayloadMap is listening to workflow events (started, terminated, completed and manages a payload map (only JCR_PATH payloads) in order to enable quick lookup for nodes/resources which might be subject of a workflow.

  • Method Details

    • isInWorkflow

      boolean isInWorkflow(String path)
      Deprecated.
      use isInWorkflow(String, boolean) instead!
      Checks whether a JCR_PATHbased path is subject of a running Workflow instance. Note:The system workflows (can be defined per osgi config) won't be taken in account here!
      Parameters:
      path - path to check
      Returns:
      true if JCR_PATHbased path is subject of a running workflow

    • isInWorkflow

      boolean isInWorkflow(String path, boolean excludeSystemWorkflows)
      Checks whether a JCR_PATHbased path is subject of a running Workflow instance.
      Parameters:
      path - path to check
      excludeSystemWorkflows - set to true to exclude system workflows from the evaluation
      Returns:
      true if JCR_PATHbased path is subject of a running workflow

    • getWorkflowInstance

      Workflow getWorkflowInstance(String path)
      Deprecated.
      use getWorkflowInstances(String, boolean) instead!
      The Workflow instance is returned. Note:The system workflows (can be defined per osgi config) won't be taken in account here!
      Parameters:
      path - node path
      Returns:
      the Workflow instance or null if not existing.

    • getWorkflowInstances

      List<Workflow> getWorkflowInstances(String path, boolean excludeSystemWorkflows)
      All Workflow instances are returned.
      Parameters:
      path - node path
      excludeSystemWorkflows - set to true to exclude system workflows from the evaluation
      Returns:
      the list of Workflow instances or an empty list is returned