Class ReviewStepDefinition


public class ReviewStepDefinition extends CreationWorkflowStepDefinition
A step in the Creation Workflow where line items are sent for review.
  • Constructor Details

    • ReviewStepDefinition

      public ReviewStepDefinition()
  • Method Details

    • withLabel

      public ReviewStepDefinition withLabel(String label)
      Description copied from class: CreationWorkflowStepDefinition
      Sets the label of the Creation Workflow step (the CreationWorkflowStepDefinition object).
      Example:
      
       def step1 = api.newCreationWorkflowStep()
               .withLabel("The Step One")
               .withUserAssignees("admin", "john.price")
       
      Overrides:
      withLabel in class CreationWorkflowStepDefinition
      Parameters:
      label - The label as a string.
      Returns:
      The CreationWorkflowStepDefinition object with the given label.
      See Also:
    • withReviewByUserGroupWithSubSteps

      public ReviewStepDefinition withReviewByUserGroupWithSubSteps(ReviewByUserGroups reviewByUserGroups)
      Defines definition of sub steps in which the line items are reviewed using a review user groups.
      Parameters:
      reviewByUserGroups - the review configuration
      Returns:
      current step
    • getLineItemFilters

      public Map<String,Filter> getLineItemFilters()
    • withLineItemFilters

      public ReviewStepDefinition withLineItemFilters(Map<String,Filter> lineItemFilters)
      Defines line items groups for this review step using filters. The line item groups are mapped to user groups. Each line item should be included in at most one line item group.
      Parameters:
      lineItemFilters - a map of user group unique names to their corresponding line item filters
      Returns:
      current step
    • getReviewByUserGroupWithSubSteps

      public ReviewByUserGroups getReviewByUserGroupWithSubSteps()