Class WorkflowInfo.WorkflowStepInfo

Object
WorkflowStepInfo
Enclosing class:
WorkflowInfo

public static class WorkflowInfo.WorkflowStepInfo extends Object
This structure describes each workflow step in detail
  • Field Details

    • 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
    • reasons

      public List<String> reasons
    • 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
    • stepHistory

      public Map<String,Object> stepHistory
  • Constructor Details

    • WorkflowStepInfo

      public WorkflowStepInfo()
  • Method Details

    • 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()