net.pricefx.common.dto

Class WorkflowDTO.ApprovalStepDTO

Object

WorkflowDTO.StepDTO

WorkflowDTO.ApprovalStepDTO

Enclosing class:

WorkflowDTO

public static class WorkflowDTO.ApprovalStepDTO
extends WorkflowDTO.StepDTO

Field Summary

Fields inherited from class WorkflowDTO.StepDTO

emailAttachment, properties, uniqueName, workflow

Constructor Summary

Constructors

Constructor and Description
ApprovalStepDTO(WorkflowDTO workflow, String uniqueName)

Method Summary

Modifier and Type	Method and Description
WorkflowDTO.ApprovalStepDTO	addProperty(String name, Object value)
void	fromMap(Map<String,Object> values)
List<Object>	getApprovalRequiredEmailAttachments()
String	getApprover() Return the current approver (or null if none set or if group approval)
List<String>	getDenialReasons()
Boolean	getExcludeSubmitter() Returns status if the submitter is excluded in case of group approval
String	getReason() Returns the reason text
String	getUserGroupApprover() Gets user group name in case of group approval (or null otherwise)
boolean	isDenialReasonOptional()
WorkflowDTO.ApprovalStepDTO	setReason(String reason) Set an explanation for the approval step
Map<String,Object>	toMap()
WorkflowDTO.ApprovalStepDTO	withApprovalRequiredEmailAttachment(Object attachment)
WorkflowDTO.ApprovalStepDTO	withApprovalRequiredEmailAttachments(Object attachments)
WorkflowDTO.ApprovalStepDTO	withApprover(String userLoginName) Last invoked of #withApprover(String), #withUserGroupApprover(String) wins
WorkflowDTO.ApprovalStepDTO	withDenialReasons(List<String> denialReasons, boolean isDenialReasonOptional)
WorkflowDTO.ApprovalStepDTO	withUserGroupApprover(String userGroupUniqueName) Last invoked of #withApprover(String), #withUserGroupApprover(String) wins
WorkflowDTO.ApprovalStepDTO	withUserGroupApprover(String userGroupUniqueName, boolean excludeSubmitter) Same as #withUserGroupApprover(String) but the submitter is excluded in case he is memeber of the group Last invoked of #withApprover(String), #withUserGroupApprover(String) wins

Methods inherited from class WorkflowDTO.StepDTO

equals, getEmailAttachment, getProperties, getUniqueName, hashCode, withEmailAttachment, withEmailAttachment

Methods inherited from class Object

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

Constructor Detail

ApprovalStepDTO

public ApprovalStepDTO(WorkflowDTO workflow,
                       String uniqueName)

Method Detail

withApprover

public WorkflowDTO.ApprovalStepDTO withApprover(String userLoginName)

Last invoked of #withApprover(String), #withUserGroupApprover(String) wins

withUserGroupApprover

public WorkflowDTO.ApprovalStepDTO withUserGroupApprover(String userGroupUniqueName)

Last invoked of #withApprover(String), #withUserGroupApprover(String) wins

withUserGroupApprover

public WorkflowDTO.ApprovalStepDTO withUserGroupApprover(String userGroupUniqueName,
                                                         boolean excludeSubmitter)

Same as #withUserGroupApprover(String) but the submitter is excluded in case he is memeber of the group Last invoked of #withApprover(String), #withUserGroupApprover(String) wins

setReason

public WorkflowDTO.ApprovalStepDTO setReason(String reason)

Set an explanation for the approval step

Parameters:

reason - The reason

Returns:

addProperty

public WorkflowDTO.ApprovalStepDTO addProperty(String name,
                                               Object value)

withApprovalRequiredEmailAttachment

public WorkflowDTO.ApprovalStepDTO withApprovalRequiredEmailAttachment(Object attachment)

withApprovalRequiredEmailAttachments

public WorkflowDTO.ApprovalStepDTO withApprovalRequiredEmailAttachments(Object attachments)

getApprover

public String getApprover()

Return the current approver (or null if none set or if group approval)

Returns:

The user name

getReason

public String getReason()

Returns the reason text

Returns:

The reason

getExcludeSubmitter

public Boolean getExcludeSubmitter()

Returns status if the submitter is excluded in case of group approval

Returns:

true if excluded

getUserGroupApprover

public String getUserGroupApprover()

Gets user group name in case of group approval (or null otherwise)

Returns:

getApprovalRequiredEmailAttachments

public List<Object> getApprovalRequiredEmailAttachments()

toMap

public Map<String,Object> toMap()

Overrides:

toMap in class WorkflowDTO.StepDTO

fromMap

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

Overrides:

fromMap in class WorkflowDTO.StepDTO

withDenialReasons

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

getDenialReasons

public List<String> getDenialReasons()

isDenialReasonOptional

public boolean isDenialReasonOptional()