com.day.cq.workflow.PayloadMap Maven / Gradle / Ivy

package com.day.cq.workflow;

import com.day.cq.workflow.exec.Workflow;

import java.util.List;

/**
 * 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.
 */
public interface PayloadMap {
    /**
     * Checks whether a JCR_PATHbased path is subject of a running 
     * {@link com.day.cq.workflow.exec.Workflow} instance.
     * Note:The system workflows (can be defined per osgi config) won't
     * be taken in account here!
     *
     * @param path path to check
     * @return true if JCR_PATHbased path is subject of a
     * running workflow
     *
     * @deprecated use {@link PayloadMap#isInWorkflow(String, boolean)} instead!
     */
    boolean isInWorkflow(String path);

    /**
     * Checks whether a JCR_PATHbased path is subject of a running 
     * {@link com.day.cq.workflow.exec.Workflow} instance.

     *
     * @param path path to check
     * @param excludeSystemWorkflows set to true to exclude system
     *        workflows from the evaluation
     *
     * @return true if JCR_PATHbased path is subject of a
     * running workflow
     */
    boolean isInWorkflow(String path, boolean excludeSystemWorkflows);

    /**
     * The {@link com.day.cq.workflow.exec.Workflow} instance is
     * returned.
     * Note:The system workflows (can be defined per osgi config) won't
     * be taken in account here!
     *
     * @param path node path
     * @return the {@link com.day.cq.workflow.exec.Workflow} instance 
     * or null if not existing.
     *
     * @deprecated use {@link PayloadMap#getWorkflowInstances(String, boolean)}  instead!
     */
    Workflow getWorkflowInstance(String path);

    /**
     * All {@link com.day.cq.workflow.exec.Workflow} instances are
     * returned.
     *
     * @param path node path
     * @param excludeSystemWorkflows set to true to exclude system
     *        workflows from the evaluation
     *
     * @return the list of {@link com.day.cq.workflow.exec.Workflow} instances
     * or an empty list is returned
     */
    public List getWorkflowInstances(String path, boolean excludeSystemWorkflows);
}