Package com.commercetools.api.models.message

Interface ApprovalFlowRejectedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface ApprovalFlowRejectedMessagePayload extends MessagePayload

Generated after an Approval Flow is rejected.

Example to create an instance using the builder pattern 

     ApprovalFlowRejectedMessagePayload approvalFlowRejectedMessagePayload = ApprovalFlowRejectedMessagePayload.builder()
             .associate(associateBuilder -> associateBuilder)
             .order(orderBuilder -> orderBuilder)
             .build()

  • Field Details

    • APPROVAL_FLOW_REJECTED

      static final String APPROVAL_FLOW_REJECTED
      discriminator value for ApprovalFlowRejectedMessagePayload
      See Also:

  • Method Details

    • getAssociate

      @NotNull @Valid @NotNull @Valid CustomerReference getAssociate()

      Reference to the Customer who rejected the Approval Flow.

      Returns:
      associate

    • getRejectionReason

      String getRejectionReason()

      Description of the reason why the Approval Flow was rejected.

      Returns:
      rejectionReason

    • getOrder

      @NotNull @Valid @NotNull @Valid OrderReference getOrder()

      Reference to the Order that received the rejection.

      Returns:
      order

    • setAssociate

      void setAssociate(CustomerReference associate)

      Reference to the Customer who rejected the Approval Flow.

      Parameters:
      associate - value to be set

    • setRejectionReason

      void setRejectionReason(String rejectionReason)

      Description of the reason why the Approval Flow was rejected.

      Parameters:
      rejectionReason - value to be set

    • setOrder

      void setOrder(OrderReference order)

      Reference to the Order that received the rejection.

      Parameters:
      order - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ApprovalFlowRejectedMessagePayloadBuilder builder()
      builder factory method for ApprovalFlowRejectedMessagePayload
      Returns:
      builder

    • builder

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

    • withApprovalFlowRejectedMessagePayload

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