Package com.broadleafcommerce.order.service

Interface OrderFulfillmentItemService<P extends com.broadleafcommerce.order.client.domain.OrderFulfillmentItem>

  • All Known Implementing Classes:
    DefaultOrderFulfillmentItemService
    public interface OrderFulfillmentItemService<P extends com.broadleafcommerce.order.client.domain.OrderFulfillmentItem>
    Service API for OrderFulfillmentItems. Note that this service provides auxiliary functions rather than the typical CRUD ones since OrderFulfillmentItems are managed through their parent OrderFulfillments.
    Author:
    Nathan Moore (nathandmoore)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      List<P> readAllReturnableFulfillmentItemsForGroup​(String orderId, String orderFulfillmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns a list of all OrderFulfillmentItems in the specified OrderFulfillment for which a ReturnAuthorization can be made, i.e., those whose parent OrderFulfillment has a status of OrderFulfillmentStatus.FULFILLED and are not already in a return.
      List<P> readAllReturnableFulfillmentItemsForOrder​(String orderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns a list of all OrderFulfillmentItems for which a ReturnAuthorization can be made, i.e., those whose parent OrderFulfillments have a status of OrderFulfillmentStatus.FULFILLED and are not already in a return.

    • Method Detail

      • readAllReturnableFulfillmentItemsForOrder

        List<P> readAllReturnableFulfillmentItemsForOrder​(String orderId,
                                                  @Nullable
                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Returns a list of all OrderFulfillmentItems for which a ReturnAuthorization can be made, i.e., those whose parent OrderFulfillments have a status of OrderFulfillmentStatus.FULFILLED and are not already in a return. This will also update the quantities on the items if any have been partially returned.
        Parameters:
        orderId - ID of the parent Order
        contextInfo - Additional sandbox and tenant info
        Returns:
        Returns a list of all OrderFulfillmentItems for which a ReturnAuthorization can be made, i.e., those whose parent OrderFulfillments have a status of OrderFulfillmentStatus.FULFILLED and are not already in a return.

      • readAllReturnableFulfillmentItemsForGroup

        List<P> readAllReturnableFulfillmentItemsForGroup​(String orderId,
                                                  String orderFulfillmentId,
                                                  @Nullable
                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Returns a list of all OrderFulfillmentItems in the specified OrderFulfillment for which a ReturnAuthorization can be made, i.e., those whose parent OrderFulfillment has a status of OrderFulfillmentStatus.FULFILLED and are not already in a return. This will also update the quantities on the items if any have been partially returned.
        Parameters:
        orderId - ID of the parent Order
        orderFulfillmentId - ID of the parent OrderFulfillment
        contextInfo - Additional sandbox and tenant info
        Returns:
        Returns a list of all OrderFulfillmentItems in the specified OrderFulfillment for which a ReturnAuthorization can be made, i.e., those whose parent OrderFulfillment has a status of OrderFulfillmentStatus.FULFILLED and are not already in a return.