com.day.cq.workflow.status.WorkflowStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of uber-jar Show documentation

The Adobe AEM Uber jar.

There is a newer version: 6.5.21

package com.day.cq.workflow.status;

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

import java.util.List;

/**
 * The WorkflowStatus holds all information for a node which
 * is in the workflow or even not
 */
public interface WorkflowStatus {
    /**
     * Indicates if a page is subject of a workflow and excludes always
     * system workflows.
     *
     * @return true if subject of a workflow otherwise
     * false
     *
     * @deprecated use {@link com.day.cq.workflow.status.WorkflowStatus#isInRunningWorkflow(boolean)} instead
     */
    boolean isInRunningWorkflow();

    /**
     * Indicates if a page is subject of a workflow
     *
     * @param excludeSystemWorkflows set to true to exclude system
     *        workflows from the evaluation
     *
     * @return true if subject of a workflow otherwise
     * false
     */
    boolean isInRunningWorkflow(boolean excludeSystemWorkflows);

    /**
     * Returns the {@link com.day.cq.workflow.exec.Workflow} instance
     *
     * @return {@link com.day.cq.workflow.exec.Workflow} instance
     *
     * @deprecated  use {@link com.day.cq.workflow.status.WorkflowStatus#getWorkflows(boolean)} instead
     */
    Workflow getWorkflow();

    /**
     * Returns the {@link com.day.cq.workflow.exec.Workflow} instances
     *
     * @param excludeSystemWorkflows set to true to exclude system
     *        workflows from the evaluation
     *
     * @return {@link com.day.cq.workflow.exec.Workflow} instances
     */
    List getWorkflows(boolean excludeSystemWorkflows);
}