net.pricefx.common.dto

Class WorkflowDTO

Object

WorkflowDTO

public class WorkflowDTO
extends Object

This class is basically the type that is exposed by the workflow formula binding workflow
So in your workflow formula you would call methods on that instance to add approval nodes and/or watcher nodes and supply further details while doing so.
The methods are designed to be used in a simple flow pattern.
Simple example:

 workflow.addApprovalStep("First Approval").withApprover("admin").setReason("Admin needs always approve")
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowDTO.ApprovalStepDTO
static class	WorkflowDTO.StepDTO
static class	WorkflowDTO.WatcherStepDTO

Constructor Summary

Constructors

Constructor and Description
WorkflowDTO(WorkflowType type, String typedId)

Method Summary

Modifier and Type	Method and Description
WorkflowDTO.ApprovalStepDTO	addApprovalStep(String uniqueName) Adds an approval step at the end of the workflow
void	addItemReason(String itemTypedId, String reason)
WorkflowDTO.WatcherStepDTO	addWatcherStep(String uniqueName) Adds a watcher step to the end of the workflow.
List<String>	getDenialReasons()
Map<String,String>	getItemReasons()
WorkflowDTO.StepDTO	getStep(String uniqueName) Retrieves a named step (if existing)
LinkedHashSet<WorkflowDTO.StepDTO>	getSteps()
WorkflowType	getType() Returns the type of the workflow.
String	getTypedId()
boolean	isDenialReasonOptional()
boolean	removeStep(String uniqueName) Removes a named step (if existing)
WorkflowDTO	withDenialReasons(List<String> denialReasons, boolean isDenialReasonOptional)

Methods inherited from class Object

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

Constructor Detail

WorkflowDTO

public WorkflowDTO(WorkflowType type,
                   String typedId)

Method Detail

addApprovalStep

public WorkflowDTO.ApprovalStepDTO addApprovalStep(String uniqueName)

Adds an approval step at the end of the workflow

Parameters:

uniqueName - Name of the step

Returns:

addWatcherStep

public WorkflowDTO.WatcherStepDTO addWatcherStep(String uniqueName)

Adds a watcher step to the end of the workflow. A watcher step cannot approve or deny, but will receive a notification when it becomes active

Parameters:

uniqueName - Name of the step

Returns:

getType

public WorkflowType getType()

Returns the type of the workflow. Corresponds to the underlying approvable.
QUOTE("quote"), PRICEGRIDITEM("pricegriditem"), REBATEAGREEMENT("rebateagreement"), CONTRACT("contract"), DATACHANGEREQUEST("dcr"), PRICELIST("pricelist"), REBATERECORD("rebaterecord");

Returns:

removeStep

public boolean removeStep(String uniqueName)

Removes a named step (if existing)

Parameters:

uniqueName - The name of the step

Returns:

getStep

public WorkflowDTO.StepDTO getStep(String uniqueName)

Retrieves a named step (if existing)

Parameters:

uniqueName - The name of the step

Returns:

addItemReason

public void addItemReason(String itemTypedId,
                          String reason)

getItemReasons

public Map<String,String> getItemReasons()

withDenialReasons

public WorkflowDTO withDenialReasons(List<String> denialReasons,
                                     boolean isDenialReasonOptional)

getDenialReasons

public List<String> getDenialReasons()

isDenialReasonOptional

public boolean isDenialReasonOptional()

getTypedId

public String getTypedId()

getSteps

public LinkedHashSet<WorkflowDTO.StepDTO> getSteps()