org.dspace.xmlworkflow.state.Workflow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
The newest version!
/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.xmlworkflow.state;

import java.sql.SQLException;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.dspace.core.Context;
import org.dspace.xmlworkflow.Role;
import org.dspace.xmlworkflow.WorkflowConfigurationException;
import org.dspace.xmlworkflow.state.actions.ActionResult;
import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem;
import org.springframework.beans.factory.BeanNameAware;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * Contains all the steps involved in a certain configured workflow.
 *
 * @author Bram De Schouwer (bram.deschouwer at dot com)
 * @author Kevin Van de Velde (kevin at atmire dot com)
 * @author Ben Bosman (ben at atmire dot com)
 * @author Mark Diggory (markd at atmire dot com)
 */
public class Workflow implements BeanNameAware {

    private String id;
    private Step firstStep;
    private List steps;

    public Step getFirstStep() {
        return firstStep;
    }

    /**
     * Get the name of this Workflow.
     * @return the name.
     * @see setBeanName
     */
    public String getID() {
        return id;
    }

    /**
     * Return a step with a given name.
     * @param stepID name of the Step to find.
     * @return the identified Step.
     * @throws WorkflowConfigurationException if the named step is not found.
     */
    public Step getStep(String stepID) throws WorkflowConfigurationException {
        for (Step step : steps) {
            if (step.getId().equals(stepID)) {
                return step;
            }
        }
        throw new WorkflowConfigurationException("Step definition not found for: " + stepID);
    }

    /**
     * Find the Step that follows a given Step given an outcome.
     * @param context
     * @param wfi the item whose steps are consulted.
     * @param currentStep the step being consulted.
     * @param outcome the outcome of {@link currentStep}.
     * @return the next step.
     * @throws WorkflowConfigurationException if the next step is invalid.
     * @throws SQLException passed through.
     */
    public Step getNextStep(Context context, XmlWorkflowItem wfi, Step currentStep, int outcome)
        throws WorkflowConfigurationException, SQLException {
        Step nextStep = currentStep.getNextStep(outcome);
        if (nextStep != null) {
            if (nextStep.isValidStep(context, wfi)) {
                return nextStep;
            } else {
                return getNextStep(context, wfi, nextStep, ActionResult.OUTCOME_COMPLETE);
            }
        } else {
            //No next step, archive it
            return null;
        }
    }

    @Autowired(required = true)
    public void setFirstStep(Step firstStep) {
        firstStep.setWorkflow(this);
        this.firstStep = firstStep;
    }

    /**
     * Get the steps that need to be executed in this workflow before the item is archived
     * @return the workflow steps
     */
    public List getSteps() {
        return steps;
    }

    /**
     * Set the steps that need to be executed in this workflow before the item is archived
     * @param steps the workflow steps
     */
    @Autowired(required = true)
    public void setSteps(List steps) {
        for (Step step : steps) {
            step.setWorkflow(this);
        }
        this.steps = steps;
    }

    /**
     * Get the roles that are used in this workflow
     * @return a map containing the roles, the role name will the key, the role itself the value
     */
    public Map getRoles() {
        Map roles = new LinkedHashMap<>();
        for (Step step : steps) {
            if (step.getRole() != null) {
                roles.put(step.getRole().getId(), step.getRole());
            }
        }
        return roles;
    }

    @Override
    public void setBeanName(String s) {
        id = s;
    }
}