Package com.broadleafcommerce.orderoperation.web.endpoint.domain

Class ReturnItemRequest

  • All Implemented Interfaces:
    Serializable
    public class ReturnItemRequest
extends Object
implements Serializable
    A request to initiate the return of an item. Used to create a ReturnAuthorizationItem.
    See Also:
    Serialized Form

    • Constructor Detail

      • ReturnItemRequest

        public ReturnItemRequest()

    • Method Detail

      • getOrderFulfillmentItemId

        public String getOrderFulfillmentItemId()
        The context ID of the OrderFulfillmentItem to return.
        Returns:
        the context ID of the order fulfillment item to return

      • getQuantity

        public Integer getQuantity()
        The quantity of the item to return.
        Returns:
        the quantity of the item to return

      • getPrimaryReturnReason

        public String getPrimaryReturnReason()
        The primary reason for the return.

        This is usually populated from an enum.

        Returns:
        the primary reason for the return

      • getSecondaryReturnReason

        public String getSecondaryReturnReason()
        The secondary reason for the return, providing more detail in addition to the primaryReturnReason.

        This is usually populated from an enum associated with the primaryReturnReason.

        Returns:
        the secondary reason for the return, providing more detail in addition to the primaryReturnReason

      • getExpectedCondition

        public String getExpectedCondition()
        The condition of the item expected when returned.

        This is usually populated from an enum.

        Returns:
        the condition of the item expected when returned

      • getReturnType

        public String getReturnType()
        The type of the return, indicating how it should be processed.

        This is usually populated from an enum. For example, REFUND might indicate that this return should result in a refund.

        Returns:
        the type of the return, indicating how it should be processed

      • getNote

        @Nullable
public String getNote()
        An optional note containing extra information about the item to return.
        Returns:
        optional note containing extra information about the item to return

      • setOrderFulfillmentItemId

        public void setOrderFulfillmentItemId​(String orderFulfillmentItemId)
        The context ID of the OrderFulfillmentItem to return.
        Parameters:
        orderFulfillmentItemId - the context ID of the order fulfillment item to return

      • setQuantity

        public void setQuantity​(Integer quantity)
        The quantity of the item to return.
        Parameters:
        quantity - the quantity of the item to return

      • setPrimaryReturnReason

        public void setPrimaryReturnReason​(String primaryReturnReason)
        The primary reason for the return.

        This is usually populated from an enum.

        Parameters:
        primaryReturnReason - the primary reason for the return

      • setSecondaryReturnReason

        public void setSecondaryReturnReason​(String secondaryReturnReason)
        The secondary reason for the return, providing more detail in addition to the primaryReturnReason.

        This is usually populated from an enum associated with the primaryReturnReason.

        Parameters:
        secondaryReturnReason - the secondary reason for the return, providing more detail in addition to the primaryReturnReason

      • setExpectedCondition

        public void setExpectedCondition​(String expectedCondition)
        The condition of the item expected when returned.

        This is usually populated from an enum.

        Parameters:
        expectedCondition - the condition of the item expected when returned

      • setReturnType

        public void setReturnType​(String returnType)
        The type of the return, indicating how it should be processed.

        This is usually populated from an enum. For example, REFUND might indicate that this return should result in a refund.

        Parameters:
        returnType - the type of the return, indicating how it should be processed

      • setNote

        public void setNote​(@Nullable
                    String note)
        An optional note containing extra information about the item to return.
        Parameters:
        note - optional note containing extra information about the item to return

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object