Package de.hybris.platform.ordercancel

Class OrderCancelRequest

java.lang.Object
de.hybris.platform.ordercancel.OrderCancelRequest
Direct Known Subclasses:
OrderCancelResponse
public class OrderCancelRequest extends Object
Represents Order Cancel requests. Instances of this class can represent:
  • Requests for canceling whole order (all order entries of an Order are discarded)
  • Requests for canceling only some of the order entries of an Order
    • An order entry may be canceled completely (order entry is discarded) or partially (i.e. only order entry quantity is reduced). It is important to note that the requests represented by this class may be processed completely, declined or processed only partially by the OrderCancelService.

  • Constructor Details

    • OrderCancelRequest

      public OrderCancelRequest(OrderModel order)
      Creates OrderCancelRequest for Order Cancel Complete
      Parameters:
      order - an Order that should be completely canceled

    • OrderCancelRequest

      public OrderCancelRequest(OrderModel order, CancelReason cancelReason)
      Creates OrderCancelRequest for Order Cancel Complete
      Parameters:
      cancelReason - reason for complete cancel
      order - an Order that should be completely canceled

    • OrderCancelRequest

      public OrderCancelRequest(OrderModel order, CancelReason cancelReason, String notes)
      Creates OrderCancelRequest for Order Cancel Complete
      Parameters:
      cancelReason - reason for complete cancel
      order - an Order that should be completely canceled
      notes - - additional notes (i.e. from CSAdmin)

    • OrderCancelRequest

      public OrderCancelRequest(OrderModel order, List<OrderCancelEntry> orderCancelEntries)
      Creates OrderCancelRequest for Order Cancel Partial.
      Parameters:
      order - an Order that should be partially canceled
      orderCancelEntries - specifies how should order entries be canceled. Each OrderCancelEntry's cancelQuantity value specifies how many items should be canceled from the corresponding OrderEntry. If cancelQuantity value equals the OrderEntry.getQuantity() value, the whole OrderEntry is be canceled.

    • OrderCancelRequest

      public OrderCancelRequest(OrderModel order, List<OrderCancelEntry> orderCancelEntries, String notes)
      Creates OrderCancelRequest for Order Cancel Partial.
      Parameters:
      order - an Order that should be partially canceled
      orderCancelEntries - specifies how should order entries be canceled. Each OrderCancelEntry's cancelQuantity value specifies how many items should be canceled from the corresponding OrderEntry. If cancelQuantity value equals the OrderEntry.getQuantity() value, the whole OrderEntry is be canceled.
      notes - - additional notes from the CSAdmin on the whole order cancellation

  • Method Details

    • getOrder

      public OrderModel getOrder()

    • getEntriesToCancel

      public List<OrderCancelEntry> getEntriesToCancel()

    • isPartialCancel

      public boolean isPartialCancel()
      Provides information about this request. If the return value is true, this request is a request for partial cancel. Otherwise it is a request for complete cancel.
      Returns:
      the isPartialCancelRepresentation

    • isPartialEntryCancel

      public boolean isPartialEntryCancel()
      Returns:
      the partialEntryCancel

    • getRequestToken

      public String getRequestToken()
      Returns:
      the requestToken

    • setRequestToken

      public void setRequestToken(String requestToken)
      Parameters:
      requestToken - the requestToken to set

    • getNotes

      public String getNotes()
      Returns:
      the notes

    • setNotes

      public void setNotes(String notes)
      Parameters:
      notes - the notes to set

    • getCancelReason

      public CancelReason getCancelReason()
      reason for complete order cancel
      Returns:
      the cancelReason

    • setCancelReason

      public void setCancelReason(CancelReason cancelReason)
      reason for complete cancel
      Parameters:
      cancelReason - the cancelReason to set