Package com.broadleafcommerce.orderoperation.domain

Class FulfillmentStatusChangeRequest

java.lang.Object
com.broadleafcommerce.orderoperation.domain.FulfillmentStatusChangeRequest
All Implemented Interfaces:
Serializable
public class FulfillmentStatusChangeRequest extends Object implements Serializable
A request DTO for changing the status of a fulfillment, or partially changing the status of some of the items in that fulfillment.
See Also:

  • Constructor Details

    • FulfillmentStatusChangeRequest

      public FulfillmentStatusChangeRequest()

  • Method Details

    • getFulfillmentId

      public String getFulfillmentId()
      The ID of the fulfillment to have its status changed.
      Returns:
      the ID of the fulfillment to have its status changed

    • getStatus

      public String getStatus()
      The status to change the fulfillment to.
      Returns:
      the status to change the fulfillment to

    • getItemQuantities

      public Map<String,Integer> getItemQuantities()
      The quantities of each fulfillment item which should change status.

      If empty or null, then the entire fulfillment will change status. Otherwise, if only a subset of the items and quantities are included, then the unchanged item quantities will be split into a new fulfillment with the previous status.

      Returns:
      the quantities of each fulfillment item which should change status

    • getIncludedExtraFees

      public Set<String> getIncludedExtraFees()
      Any extra fees to include when performing this status change. Extra fees are represented by order items but not fulfillment items and so normally aren't included in status changes.

      This is primarily useful for including fees in cancel and capture events. This may not mean anything for other status changes.

      Since:
      Order Operations 2.2.0, Release Train 2.3.0

    • setFulfillmentId

      public void setFulfillmentId(String fulfillmentId)
      The ID of the fulfillment to have its status changed.
      Parameters:
      fulfillmentId - the ID of the fulfillment to have its status changed

    • setStatus

      public void setStatus(String status)
      The status to change the fulfillment to.
      Parameters:
      status - the status to change the fulfillment to

    • setItemQuantities

      public void setItemQuantities(Map<String,Integer> itemQuantities)
      The quantities of each fulfillment item which should change status.

      If empty or null, then the entire fulfillment will change status. Otherwise, if only a subset of the items and quantities are included, then the unchanged item quantities will be split into a new fulfillment with the previous status.

      Parameters:
      itemQuantities - the quantities of each fulfillment item which should change status

    • setIncludedExtraFees

      public void setIncludedExtraFees(Set<String> includedExtraFees)
      Any extra fees to include when performing this status change. Extra fees are represented by order items but not fulfillment items and so normally aren't included in status changes.

      This is primarily useful for including fees in cancel and capture events. This may not mean anything for other status changes.

      Since:
      Order Operations 2.2.0, Release Train 2.3.0

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object