Package com.commercetools.api.models.approval_flow

Interface ApprovalFlowApproveAction

All Superinterfaces:
ApprovalFlowUpdateAction
public interface ApprovalFlowApproveAction extends ApprovalFlowUpdateAction

This update action allows an Associate to approve an Approval Flow. The process takes into account all Associate Roles held by the Associate, aligning with the matched Approval Rules and their respective approver hierarchies.

When every required Associate has given their approval, the Approval Flow achieves a fully approved state, automatically updating its status to Approved. An Associate is eligible to approve only if their roles are within tiers of the Approval Rule hierarchy that are yet to be fully approved or rejected. As such, an Associate may be able to give their approval more than once.

Example to create an instance using the builder pattern 

     ApprovalFlowApproveAction approvalFlowApproveAction = ApprovalFlowApproveAction.builder()
             .build()

  • Field Details

  • Method Details

    • of

      static ApprovalFlowApproveAction of()
      factory method
      Returns:
      instance of ApprovalFlowApproveAction

    • of

      static ApprovalFlowApproveAction of(ApprovalFlowApproveAction template)
      factory method to create a shallow copy ApprovalFlowApproveAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ApprovalFlowApproveAction deepCopy(@Nullable ApprovalFlowApproveAction template)
      factory method to create a deep copy of ApprovalFlowApproveAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ApprovalFlowApproveActionBuilder builder()
      builder factory method for ApprovalFlowApproveAction
      Returns:
      builder

    • builder

      static ApprovalFlowApproveActionBuilder builder(ApprovalFlowApproveAction template)
      create builder for ApprovalFlowApproveAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withApprovalFlowApproveAction

      default <T> T withApprovalFlowApproveAction(Function<ApprovalFlowApproveAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ApprovalFlowApproveAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference