Package net.pricefx.workflowengine
Class WorkflowInfo.WorkflowStepInfo
- Object
-
- WorkflowStepInfo
-
- Enclosing class:
- WorkflowInfo
public static class WorkflowInfo.WorkflowStepInfo extends Object
This structure describes each workflow step in detail
-
-
Field Summary
Fields Modifier and Type Field Description Date
approvalDate
Date of approval, GMT timezoneList<?>
approvalRequiredEmailAttachments
The attachmentsString
comment
A user comment entered during approval/denialBoolean
emailAttachment
Has this step attachments to be sent along the notification email?String
emailAttachmentTemplateName
If emailAttachment is true, then this settings allow to use any other than default excel templateList<String>
executedByNames
Approved by user(s) : user names for easier displayList<User>
executedByUsers
Approved by user(s)WorkflowStep.WorkflowStepExecutionStatus
executionStatus
The status of the step Can be: INITIALIZED, PREEXECUTED, EXECUTED_DENIED, EXECUTED_APPROVED, EXECUTED_WITHDRAWN, ALREADY_SATISFIEDBoolean
isActiveStep
Is the this step active?Boolean
isEmailWatcher
Boolean
isGroupApprover
Is this step an approval node by a user group?Boolean
isUserApprover
Is the step a an approval node by individual user(s)?List<String>
reasons
Map<String,Object>
stepHistory
WorkflowStep.WorkflowStepType
stepType
Either APPROVAL or WATCHER Watchers are just notified and do not need to act.String
uniqueName
The unique workflow step identifierList<User>
userApprovers
A list of users that can approveList<UserGroup>
userGroupApprovers
A list of groups that can approveString
userGroupLabel
Deprecated.Collection<String>
watcherEmails
-
Constructor Summary
Constructors Constructor Description WorkflowStepInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Date
getApprovalDatePartitionDefaultTZ()
Date of approval, partition default timezoneString
getExecutionStatusI18n()
String
getReason()
Deprecated.User
getUserApprover()
Deprecated.UserGroup
getUserGroupApprover()
Deprecated.Boolean
isAlreadySatisfied()
Boolean
isApprovalStep()
Boolean
isApproved()
Boolean
isDenied()
Boolean
isInitialized()
Boolean
isPreExecuted()
Boolean
isWatcherStep()
Boolean
isWithdrawn()
-
-
-
Field Detail
-
uniqueName
public String uniqueName
The unique workflow step identifier
-
isUserApprover
public Boolean isUserApprover
Is the step a an approval node by individual user(s)?
-
isGroupApprover
public Boolean isGroupApprover
Is this step an approval node by a user group?
-
userApprovers
public List<User> userApprovers
A list of users that can approve
-
userGroupApprovers
public List<UserGroup> userGroupApprovers
A list of groups that can approve
-
userGroupLabel
@Deprecated public String userGroupLabel
Deprecated.
-
executionStatus
public WorkflowStep.WorkflowStepExecutionStatus executionStatus
The status of the step Can be: INITIALIZED, PREEXECUTED, EXECUTED_DENIED, EXECUTED_APPROVED, EXECUTED_WITHDRAWN, ALREADY_SATISFIED
-
approvalDate
public Date approvalDate
Date of approval, GMT timezone
-
comment
public String comment
A user comment entered during approval/denial
-
stepType
public WorkflowStep.WorkflowStepType stepType
Either APPROVAL or WATCHER Watchers are just notified and do not need to act. Workflow advances immediately to next step
-
isEmailWatcher
public Boolean isEmailWatcher
-
watcherEmails
public Collection<String> watcherEmails
-
emailAttachment
public Boolean emailAttachment
Has this step attachments to be sent along the notification email?
-
emailAttachmentTemplateName
public String emailAttachmentTemplateName
If emailAttachment is true, then this settings allow to use any other than default excel template
-
approvalRequiredEmailAttachments
public List<?> approvalRequiredEmailAttachments
The attachments
-
isActiveStep
public Boolean isActiveStep
Is the this step active?
-
executedByUsers
public List<User> executedByUsers
Approved by user(s)
-
executedByNames
public List<String> executedByNames
Approved by user(s) : user names for easier display
-
-
Method Detail
-
getReason
@Deprecated public String getReason()
Deprecated.A workflow formula generated reason text to explain the step
-
getApprovalDatePartitionDefaultTZ
public Date getApprovalDatePartitionDefaultTZ()
Date of approval, partition default timezone
-
getUserApprover
@Deprecated public User getUserApprover()
Deprecated.
-
getUserGroupApprover
@Deprecated public UserGroup getUserGroupApprover()
Deprecated.
-
isApprovalStep
public Boolean isApprovalStep()
-
isWatcherStep
public Boolean isWatcherStep()
-
isInitialized
public Boolean isInitialized()
-
isPreExecuted
public Boolean isPreExecuted()
-
isDenied
public Boolean isDenied()
-
isApproved
public Boolean isApproved()
-
isAlreadySatisfied
public Boolean isAlreadySatisfied()
-
isWithdrawn
public Boolean isWithdrawn()
-
getExecutionStatusI18n
public String getExecutionStatusI18n()
-
-