Package com.broadleafcommerce.orderoperation.service.generate

Class DefaultReturnGenerationService.GenerateReturnHydrationResult

  • Enclosing class:
    DefaultReturnGenerationService
    public static class DefaultReturnGenerationService.GenerateReturnHydrationResult
extends Object
    An intermediary data structure used internally by ReturnGenerationService to hold all the relevant data for generating returns, to prevent processing the data multiple times and make it easier to pass the data between methods.

    • Constructor Detail

      • GenerateReturnHydrationResult

        public GenerateReturnHydrationResult()

    • Method Detail

      • getTotalQuantity

        protected int getTotalQuantity​(String itemId)
        Gets the total quantity for the given item id.
        Parameters:
        itemId - fulfillment item id to get the total quantity for
        Returns:
        the total quantity for the given item id

      • getQuantityAlreadyReturned

        protected int getQuantityAlreadyReturned​(String itemId)
        Gets the quantity that is already returned for the given item id.
        Parameters:
        itemId - fulfillment item id to get the return quantity for
        Returns:
        the quantity that is already returned for the given item id

      • getQuantityBeingReturned

        protected int getQuantityBeingReturned​(String itemId)
        Gets the quantity that is being returned for the given item id.
        Parameters:
        itemId - fulfillment item id to get the quantity being returned

      • isItemBeingReturned

        protected boolean isItemBeingReturned​(String itemId)
        Determines if the given item id is being returned by checking the returnRequestItemQuantities and the quantity corresponding to the request.
        Parameters:
        itemId - fulfillment item id to check if it's being returned
        Returns:
        true if the given item id is being returned, otherwise false

      • getOrder

        public com.broadleafcommerce.order.client.domain.Order getOrder()
        The Order where the items being returned are from.

      • getOrderItemById

        public Map<String,​com.broadleafcommerce.order.client.domain.OrderItem> getOrderItemById()
        A map of OrderItem by OrderItem.getId().

      • getFulfillment

        public com.broadleafcommerce.order.client.domain.OrderFulfillment getFulfillment()
        The OrderFulfillment containing the items being returned.

      • getFulfillmentItemById

        public Map<String,​com.broadleafcommerce.order.client.domain.OrderFulfillmentItem> getFulfillmentItemById()
        A map of OrderFulfillmentItem by OrderFulfillmentItem.getId().

      • getReturnRequestItemQuantities

        public Map<String,​Integer> getReturnRequestItemQuantities()
        A map of requested quantity to be returned by OrderFulfillmentItem.getId().

      • getFulfillmentItemQuantities

        public Map<String,​Integer> getFulfillmentItemQuantities()
        A map of total quantity by OrderFulfillmentItem.getId() for the given fulfillment.

      • getExistingReturnItemsByItemId

        public Map<String,​List<com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem>> getExistingReturnItemsByItemId()
        A map of existing ReturnAuthorizationItems by OrderFulfillmentItem.getId().

      • getExistingReturnItemQuantities

        public Map<String,​Integer> getExistingReturnItemQuantities()
        A map of quantity already returned by OrderFulfillmentItem.getId().

      • setOrder

        public void setOrder​(com.broadleafcommerce.order.client.domain.Order order)
        The Order where the items being returned are from.

      • setOrderItemById

        public void setOrderItemById​(Map<String,​com.broadleafcommerce.order.client.domain.OrderItem> orderItemById)
        A map of OrderItem by OrderItem.getId().

      • setFulfillment

        public void setFulfillment​(com.broadleafcommerce.order.client.domain.OrderFulfillment fulfillment)
        The OrderFulfillment containing the items being returned.

      • setFulfillmentItemById

        public void setFulfillmentItemById​(Map<String,​com.broadleafcommerce.order.client.domain.OrderFulfillmentItem> fulfillmentItemById)
        A map of OrderFulfillmentItem by OrderFulfillmentItem.getId().

      • setReturnRequestItemQuantities

        public void setReturnRequestItemQuantities​(Map<String,​Integer> returnRequestItemQuantities)
        A map of requested quantity to be returned by OrderFulfillmentItem.getId().

      • setFulfillmentItemQuantities

        public void setFulfillmentItemQuantities​(Map<String,​Integer> fulfillmentItemQuantities)
        A map of total quantity by OrderFulfillmentItem.getId() for the given fulfillment.

      • setExistingReturnItemsByItemId

        public void setExistingReturnItemsByItemId​(Map<String,​List<com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem>> existingReturnItemsByItemId)
        A map of existing ReturnAuthorizationItems by OrderFulfillmentItem.getId().

      • setExistingReturnItemQuantities

        public void setExistingReturnItemQuantities​(Map<String,​Integer> existingReturnItemQuantities)
        A map of quantity already returned by OrderFulfillmentItem.getId().

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object