com.adobe.granite.workflow.status.WorkflowStatus Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2012 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.granite.workflow.status;

import com.adobe.granite.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
     *
     * @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.adobe.granite.workflow.exec.Workflow} instances
     *
     * @param excludeSystemWorkflows set to true to exclude system
     *        workflows from the evaluation
     *
     * @return {@link com.adobe.granite.workflow.exec.Workflow} instances
     */
    List getWorkflows(boolean excludeSystemWorkflows);
}