net.pricefx.common.dto

Class WorkflowDTO.StepDTO<T extends WorkflowDTO.StepDTO>

Object

WorkflowDTO.StepDTO<T>

Direct Known Subclasses:

WorkflowDTO.ApprovalStepDTO, WorkflowDTO.WatcherStepDTO

Enclosing class:

WorkflowDTO

public abstract static class WorkflowDTO.StepDTO<T extends WorkflowDTO.StepDTO>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	alreadySatisfiedComment
protected Boolean	emailAttachment Signals that approvable should be exported and attached to email in the given step
protected String	emailAttachmentTemplateName
protected Map<String,Object>	properties
protected String	uniqueName
protected WorkflowDTO	workflow

Constructor Summary

Constructors

Constructor and Description
StepDTO(WorkflowDTO workflow, String uniqueName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	fromMap(Map<String,Object> values)
String	getAlreadySatisfiedComment()
Boolean	getEmailAttachment() Retrieves the attachment sending setting
String	getEmailAttachmentTemplateName()
Map<String,Object>	getProperties()
String	getUniqueName() Gets the name of the step
int	hashCode()
protected List<String>	readSingleValue(String name)
Map<String,Object>	toMap()
T	withAlreadySatisfied() Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.
T	withAlreadySatisfied(String comment) Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.
T	withEmailAttachment() Makes the step send the attachment along with the notification Same as withEmailAttachment(true)
T	withEmailAttachment(Boolean emailAttachment) Makes the step send the attachment along with the notification
T	withEmailAttachmentTemplateName(String emailAttachmentTemplateName)

Methods inherited from class Object

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

Field Detail

workflow

protected WorkflowDTO workflow

properties

protected Map<String,Object> properties

uniqueName

protected String uniqueName

emailAttachment

protected Boolean emailAttachment

Signals that approvable should be exported and attached to email in the given step

emailAttachmentTemplateName

protected String emailAttachmentTemplateName

alreadySatisfiedComment

protected String alreadySatisfiedComment

Constructor Detail

StepDTO

public StepDTO(WorkflowDTO workflow,
               String uniqueName)

Method Detail

getProperties

public Map<String,Object> getProperties()

getUniqueName

public String getUniqueName()

Gets the name of the step

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

withEmailAttachment

public T withEmailAttachment()

Makes the step send the attachment along with the notification Same as withEmailAttachment(true)

withEmailAttachment

public T withEmailAttachment(Boolean emailAttachment)

Makes the step send the attachment along with the notification

Parameters:

emailAttachment - Send attachment (true) or not (false)

getEmailAttachment

public Boolean getEmailAttachment()

Retrieves the attachment sending setting

Returns:

toMap

public Map<String,Object> toMap()

fromMap

public void fromMap(Map<String,Object> values)

readSingleValue

protected List<String> readSingleValue(String name)

withEmailAttachmentTemplateName

public T withEmailAttachmentTemplateName(String emailAttachmentTemplateName)

getEmailAttachmentTemplateName

public String getEmailAttachmentTemplateName()

getAlreadySatisfiedComment

public String getAlreadySatisfiedComment()

withAlreadySatisfied

public T withAlreadySatisfied()

Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.

withAlreadySatisfied

public T withAlreadySatisfied(String comment)

Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.

Parameters:

comment - If set to non-null value, the execution of the step will skipped and its value used as the step's comment