Package com.broadleafcommerce.order.service

Interface OrderFulfillmentViewService<P extends OrderFulfillmentView>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.data.domain.Page<P> readAll​(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieve all OrderFulfillmentViews using a structured query string to drive the query criteria.
      org.springframework.data.domain.Page<P> readAllByGroupReferenceNumber​(String groupReferenceNumber, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all of the OrderFulfillmentViews that are associated with the given groupReferenceNumber.
      List<P> readAllByOrderId​(String orderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all of the OrderFulfillmentViews that are associated with the given orderId.
      P readById​(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads the requested order fulfillment view by OrderFulfillment.getId().

    • Method Detail

      • readById

        P readById​(String id,
           @Nullable
           com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Reads the requested order fulfillment view by OrderFulfillment.getId().
        Parameters:
        id - the ID of the order fulfillment to fetch
        contextInfo - context information surrounding multitenant state. When in a tenant context, the narrowing semantics will return a record within the ContextRequest.getTenantId() regardless of whether it is associated to an application or not. This allows users to read application-level fulfillments from a tenant-context. In an application context, narrowing will apply normally.
        Returns:
        the requested order fulfillment view
        Throws:
        com.broadleafcommerce.data.tracking.core.exception.EntityMissingException - if the fulfillment was not found

      • readAllByOrderId

        List<P> readAllByOrderId​(String orderId,
                         @Nullable
                         com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Reads all of the OrderFulfillmentViews that are associated with the given orderId.

        Assumes that the context contains the application containing the order.

        Parameters:
        orderId - The ID of the order to find fulfillments for
        contextInfo - context information surrounding sandboxing and multitenant state
        Returns:
        the fulfillment views that are associated with the given orderId

      • readAll

        org.springframework.data.domain.Page<P> readAll​(@NonNull
                                                cz.jirutka.rsql.parser.ast.Node filters,
                                                @NonNull
                                                org.springframework.data.domain.Pageable pageable,
                                                com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Retrieve all OrderFulfillmentViews using a structured query string to drive the query criteria. The filters string is parsed by an internal implementation and the result is added to the query before executing the fetch against the persistence store. See FilterParser for more information.
        Parameters:
        filters - the RSQL Node used to restrict result, must not be null
        pageable - may be Pageable.unpaged(), must not be null.
        contextInfo - Request context information around sandbox and multitenant state
        Returns:
        The subset (page) of narrowed entities

      • readAllByGroupReferenceNumber

        org.springframework.data.domain.Page<P> readAllByGroupReferenceNumber​(String groupReferenceNumber,
                                                                      cz.jirutka.rsql.parser.ast.Node filters,
                                                                      org.springframework.data.domain.Pageable pageable,
                                                                      @Nullable
                                                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Reads all of the OrderFulfillmentViews that are associated with the given groupReferenceNumber.
        Parameters:
        groupReferenceNumber - the reference number of the order fulfillments to fetch
        filters - the RSQL Node used to restrict the results
        pageable - describes the page of results to return
        contextInfo - context information around sandbox and multitenant state
        Returns:
        The page of narrowed order fulfillment views