Package net.pricefx.common.dto
Class WorkflowDTO.StepDTO<T extends WorkflowDTO.StepDTO>
- Object
-
- 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 Description protected StringalreadySatisfiedCommentprotected BooleanemailAttachmentSignals that approvable should be exported and attached to email in the given stepprotected StringemailAttachmentTemplateNameprotected Map<String,Object>propertiesprotected StringuniqueNameprotected WorkflowDTOworkflow
-
Constructor Summary
Constructors Constructor Description StepDTO(WorkflowDTO workflow, String uniqueName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)voidfromMap(Map<String,Object> values)StringgetAlreadySatisfiedComment()BooleangetEmailAttachment()Retrieves the attachment sending settingStringgetEmailAttachmentTemplateName()Map<String,Object>getProperties()StringgetUniqueName()Gets the name of the stepinthashCode()protected List<String>readSingleValue(String name)Map<String,Object>toMap()TwithAlreadySatisfied()Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.TwithAlreadySatisfied(String comment)Mark current step as already satisfied, workflowengine will skip its processing once marked as satisfied.TwithEmailAttachment()Makes the step send the attachment along with the notification Same aswithEmailAttachment(true)TwithEmailAttachment(Boolean emailAttachment)Makes the step send the attachment along with the notificationTwithEmailAttachmentTemplateName(String emailAttachmentTemplateName)
-
-
-
Field Detail
-
workflow
protected WorkflowDTO workflow
-
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
-
getUniqueName
public String getUniqueName()
Gets the name of the step- Returns:
-
withEmailAttachment
public T withEmailAttachment()
Makes the step send the attachment along with the notification Same aswithEmailAttachment(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:
-
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
-
-