Package com.broadleafcommerce.order.client.domain

Enum Class OrderFulfillmentStatus

java.lang.Object
java.lang.Enum<OrderFulfillmentStatus>
com.broadleafcommerce.order.client.domain.OrderFulfillmentStatus
All Implemented Interfaces:
Serializable, Comparable<OrderFulfillmentStatus>, Constable
public enum OrderFulfillmentStatus extends Enum<OrderFulfillmentStatus>
Default values for OrderFulfillment.getStatus().
Author:
Samarth Dhruva (samarthd)

  • Enum Constant Details

    • NEW

      public static final OrderFulfillmentStatus NEW
      Indicates that the fulfillment is newly created.

    • PENDING_INVENTORY

      public static final OrderFulfillmentStatus PENDING_INVENTORY
      Indicates that the fulfillment was created but cannot be fulfilled until inventory is available.

      This state is usually entered when we expect future stock to become available soon, such as Pre-Order or Backorder items.

    • CAPTURING_PAYMENT

      public static final OrderFulfillmentStatus CAPTURING_PAYMENT
      Indicates that the fulfillment payment is currently being captured.

      Putting a fulfillment into this status should trigger payment capture. Only used if payment is being captured separately from authorization.

    • CAPTURE_AWAITING_RESULT

      public static final OrderFulfillmentStatus CAPTURE_AWAITING_RESULT
      Indicates that the fulfillment payment is sent to the payment gateway but awaiting transaction result. Note that if one of the captures is awaiting result in a multiple-payment scenario, the order fulfillment will still have the awaiting result status.

    • PAYMENT_CAPTURED

      public static final OrderFulfillmentStatus PAYMENT_CAPTURED
      Indicates that the fulfillment payment was successfully captured.

      This status means that a fulfillment can now be fulfilled. Only used if payment is being captured separately from authorization.

    • PAYMENT_CAPTURE_FAILED

      public static final OrderFulfillmentStatus PAYMENT_CAPTURE_FAILED
      Indicates that the fulfillment payment was unable to be captured.

      The only action that can be performed on a status in this state is a cancellation. Cancelling this fulfillment may be necessary in the case of multiple payments, since only one payment might have failed, and others could have been captured. Only used if payment is being captured separately from authorization.

    • FULFILLING

      public static final OrderFulfillmentStatus FULFILLING
      Indicates that the fulfillment is in the process of being fulfilled.

    • FULFILLED

      public static final OrderFulfillmentStatus FULFILLED
      Indicates that the fulfillment has been fulfilled.

    • FULFILL_FAILED

      public static final OrderFulfillmentStatus FULFILL_FAILED
      Indicates that the fulfillment failed to be fulfilled.

    • REFUND_AWAITING_RESULT

      public static final OrderFulfillmentStatus REFUND_AWAITING_RESULT
      Indicates that the fulfillment payment is sent to the payment gateway but awaiting refund transaction result. This status is used for the canceling captured fulfillment scenarios. It is different from ReturnConfirmationStatus.REFUND_AWAITING_RESULT

    • REFUND_FAILED

      public static final OrderFulfillmentStatus REFUND_FAILED
      Indicates that the fulfillment payments were not fully refunded. This status is used for the canceling captured fulfillment scenarios. It is different from ReturnConfirmationStatus.REFUND_FAILED

    • CANCELLED

      public static final OrderFulfillmentStatus CANCELLED
      Indicates that the fulfillment has been cancelled.

  • Method Details

    • values

      public static OrderFulfillmentStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OrderFulfillmentStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isNew

      public static boolean isNew(String status)

    • isCapturingPayment

      public static boolean isCapturingPayment(String status)

    • isCaptureAwaitingResult

      public static boolean isCaptureAwaitingResult(String status)

    • isPaymentCaptured

      public static boolean isPaymentCaptured(String status)

    • isPaymentCaptureFailed

      public static boolean isPaymentCaptureFailed(String status)

    • isFulfilling

      public static boolean isFulfilling(String status)

    • isFulfilled

      public static boolean isFulfilled(String status)

    • isFulfillFailed

      public static boolean isFulfillFailed(String status)

    • isRefundFailed

      public static boolean isRefundFailed(String status)

    • isRefundAwaitingResult

      public static boolean isRefundAwaitingResult(String status)

    • isCancelled

      public static boolean isCancelled(String status)