org.dspace.xmlworkflow.state

Class Step

java.lang.Object

org.dspace.xmlworkflow.state.Step

public class Step
extends java.lang.Object

A class that contains all the data of an xlworkflow step

Author:

Bram De Schouwer (bram.deschouwer at dot com), Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

Constructor Summary

Constructors

Constructor and Description
Step(java.lang.String id, Workflow workflow, Role role, UserSelectionActionConfig userSelectionMethod, java.util.List<java.lang.String> actionConfigsList, java.util.Map<java.lang.Integer,java.lang.String> outcomes, int requiredUsers)

Method Summary

Methods

Modifier and Type	Method and Description
WorkflowActionConfig	getActionConfig(java.lang.String actionID)
java.lang.String	getId()
WorkflowActionConfig	getNextAction(WorkflowActionConfig currentAction)
java.lang.String	getNextStepID(int outcome)
int	getRequiredUsers()
Role	getRole()
UserSelectionActionConfig	getUserSelectionMethod()
Workflow	getWorkflow()
boolean	hasUI() Boolean that returns whether or not the actions in this step have a ui
boolean	isFinished(Context c, XmlWorkflowItem wfi) Check if enough users have finished this step for it to continue
boolean	isValidStep(Context context, XmlWorkflowItem wfi)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Step

public Step(java.lang.String id,
    Workflow workflow,
    Role role,
    UserSelectionActionConfig userSelectionMethod,
    java.util.List<java.lang.String> actionConfigsList,
    java.util.Map<java.lang.Integer,java.lang.String> outcomes,
    int requiredUsers)

Method Detail

getActionConfig

public WorkflowActionConfig getActionConfig(java.lang.String actionID)

hasUI

public boolean hasUI()

Boolean that returns whether or not the actions in this step have a ui

Returns:

a boolean

getNextStepID

public java.lang.String getNextStepID(int outcome)
                               throws WorkflowException,
                                      java.io.IOException,
                                      WorkflowConfigurationException,
                                      java.sql.SQLException

Throws:

WorkflowException

java.io.IOException

WorkflowConfigurationException

java.sql.SQLException

isValidStep

public boolean isValidStep(Context context,
                  XmlWorkflowItem wfi)
                    throws WorkflowConfigurationException,
                           java.sql.SQLException

Throws:

WorkflowConfigurationException

java.sql.SQLException

getUserSelectionMethod

public UserSelectionActionConfig getUserSelectionMethod()

getNextAction

public WorkflowActionConfig getNextAction(WorkflowActionConfig currentAction)

getId

public java.lang.String getId()

getWorkflow

public Workflow getWorkflow()

isFinished

public boolean isFinished(Context c,
                 XmlWorkflowItem wfi)
                   throws java.sql.SQLException

Check if enough users have finished this step for it to continue

Parameters:

wfi - the workflow item to check

Returns:

if enough users have finished this task

Throws:

java.sql.SQLException

getRequiredUsers

public int getRequiredUsers()

getRole

public Role getRole()