Package com.broadleafcommerce.order.client.domain

Class IncludedFee

java.lang.Object
com.broadleafcommerce.order.client.domain.IncludedFee
All Implemented Interfaces:
Serializable
public class IncludedFee extends Object implements Serializable
Represents a fee that is included in actions against an OrderFulfillment. These are recorded on the OrderFulfillment at the time a relevant action is taken such as capturing payment or cancelling items when the caller specifies that fees should be captured or canceled (reversed/refunded) at the same time.
Since:
Order Client 2.0.4, Release Train 2.3.0
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Details

    • IncludedFee

      public IncludedFee()

  • Method Details

    • getOrderItemId

      public String getOrderItemId()
      The context id of the fee order item being included.
      Returns:
      the context ID of the fee order item being included

    • getName

      public String getName()
      From the OrderItem.getName().

    • getNote

      @Nullable public String getNote()
      An optional note containing extra information about the fee being included.
      Returns:
      optional note containing extra information about the fee being included

    • getRefundableAmount

      public javax.money.MonetaryAmount getRefundableAmount()
      From the OrderItem.getRefundAmount().

    • getTotal

      public javax.money.MonetaryAmount getTotal()
      From the OrderItem.getTotal().

    • setOrderItemId

      public void setOrderItemId(String orderItemId)
      The context id of the fee order item being included.
      Parameters:
      id - the context ID of the fee order item being included

    • setName

      public void setName(String name)
      From the OrderItem.getName().

    • setNote

      public void setNote(@Nullable String note)
      An optional note containing extra information about the fee being included.
      Parameters:
      note - optional note containing extra information about the fee being included

    • setRefundableAmount

      public void setRefundableAmount(javax.money.MonetaryAmount refundableAmount)
      From the OrderItem.getRefundAmount().

    • setTotal

      public void setTotal(javax.money.MonetaryAmount total)
      From the OrderItem.getTotal().

    • 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