Package com.commercetools.api.models.approval_flow

Interface ApprovalFlowRejectAction

All Superinterfaces:
ApprovalFlowUpdateAction
public interface ApprovalFlowRejectAction extends ApprovalFlowUpdateAction

This update action allows an Associate to reject an Approval Flow, setting its status to Rejected. The process takes into account all Associate Roles held by the Associate, aligning with the matched Approval Rules and their respective approver hierarchies. Even a single rejection in the process will result in the rejection of the entire Approval Flow.

An Associate is eligible to reject only if their roles are within tiers of the Approval Rule hierarchy that are yet to be rejected. An Associate may alter a prior approval into a rejection.

Example to create an instance using the builder pattern 

     ApprovalFlowRejectAction approvalFlowRejectAction = ApprovalFlowRejectAction.builder()
             .build()

  • Field Details

  • Method Details

    • getReason

      String getReason()

      The reason for the rejection of the Approval Flow.

      Returns:
      reason

    • setReason

      void setReason(String reason)

      The reason for the rejection of the Approval Flow.

      Parameters:
      reason - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ApprovalFlowRejectActionBuilder builder()
      builder factory method for ApprovalFlowRejectAction
      Returns:
      builder

    • builder

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

    • withApprovalFlowRejectAction

      default <T> T withApprovalFlowRejectAction(Function<ApprovalFlowRejectAction,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<ApprovalFlowRejectAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference