Package com.broadleafcommerce.order.service

Interface OrderFulfillmentService<P extends com.broadleafcommerce.order.client.domain.OrderFulfillment>

All Superinterfaces:

com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

All Known Implementing Classes:

DefaultOrderFulfillmentService

public interface OrderFulfillmentService<P extends com.broadleafcommerce.order.client.domain.OrderFulfillment>
extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

Service API for OrderFulfillment. Supported by OrderFulfillmentRepository.

Method Summary

Modifier and Type	Method	Description
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)	Retrieves the order fulfillments matching the provided groupReferenceNumber and filters.
org.springframework.data.domain.Page<P>	readAllByGroupReferenceNumberAndMatchingTenant(String groupReferenceNumber, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the order fulfillments matching the provided groupReferenceNumber and filters, and the tenant from ContextInfo if present.
List<P>	readAllByOrderId(String orderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads all of the OrderFulfillments that are associated with the given orderId.
org.springframework.data.domain.Page<P>	readAllByOrderId(String orderId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads a page of all of the OrderFulfillments that are associated with the given orderId.
List<P>	readAllByOrderIdAndMatchingTenant(String orderId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the order fulfillment matching the provided ID and the tenant from ContextInfo if present.
List<P>	readAllByOrderIdAndStatus(String orderId, String status, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads all of the order OrderFulfillments which are associated with the given orderId.
List<P>	readAllByOrderIdIn(Collection<String> orderIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads all of the OrderFulfillments which are associated with any of the given orderIds.
org.springframework.data.domain.Page<P>	readAllMatchingTenant(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the order fulfillments matching the provided filters and the tenant from ContextInfo if present.
List<String>	readAllUniqueIds(int page, cz.jirutka.rsql.parser.ast.Node filters)	Retrieves a list of unique order fulfillment context IDs no larger than page.
Optional<P>	readByContextIdAndMatchingTenant(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the order fulfillment matching the provided ID and the tenant from ContextInfo if present.
Optional<P>	readByContextIdAndStatus(String id, String status, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads the OrderFulfillment for the given id and status.
List<P>	replaceOrCreateAll(Collection<P> fulfillments, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Replace all of the given fulfillments which already exist, or create them.

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

readAll, readAll, readAll, readAll

Method Detail

readAllByOrderId

org.springframework.data.domain.Page<P> readAllByOrderId(String orderId,
                                                         cz.jirutka.rsql.parser.ast.Node filters,
                                                         org.springframework.data.domain.Pageable page,
                                                         @Nullable
                                                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Reads a page of all of the OrderFulfillments that are associated with the given orderId.

Parameters:

orderId - The ID of the order to find fulfillments for

filters - additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.

page - the requested page of results from the database

context - context information surrounding sandboxing and multitenant state

Returns:

A page of fulfillments that are associated with the given orderId

readAllByOrderId

List<P> readAllByOrderId(String orderId,
                         @Nullable
                         com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Reads all of the OrderFulfillments that are associated with the given orderId.

Parameters:

orderId - The ID of the order to find fulfillments for

context - context information surrounding sandboxing and multitenant state

Returns:

the fulfillments that are associated with the given orderId

readAllByOrderIdIn

List<P> readAllByOrderIdIn(Collection<String> orderIds,
                           @Nullable
                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Reads all of the OrderFulfillments which are associated with any of the given orderIds.

Parameters:

orderIds - The IDs of the orders to find fulfillments for

context - context information surrounding sandboxing and multitenant state

Returns:

the fulfillments which are associated with the given orderIds

replaceOrCreateAll

List<P> replaceOrCreateAll(Collection<P> fulfillments,
                           @Nullable
                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Replace all of the given fulfillments which already exist, or create them.

Parameters:

fulfillments - the fulfillments to replace or create

context - context information surrounding sandboxing and multitenant state

Returns:

the replaced and created fulfillments

readAllUniqueIds

List<String> readAllUniqueIds(int page,
                              @NonNull
                              cz.jirutka.rsql.parser.ast.Node filters)

Retrieves a list of unique order fulfillment context IDs no larger than page. It is expected that any appropriate offset is achieved through criteria designated in filters.

Parameters:

page - the requested page of results from the database. -1 indicates no limit.

filters - An RSQL filter used to narrow query results. May be EmptyNode if no filters should be applied.

Returns:

unique order fulfillment IDs

readAllByOrderIdAndStatus

List<P> readAllByOrderIdAndStatus(String orderId,
                                  String status,
                                  @Nullable
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Reads all of the order OrderFulfillments which are associated with the given orderId.

Parameters:

orderId - The ID of the parent Order

status - The OrderFulfillment.getStatus()

context - context information surrounding sandboxing and multitenant state

Returns:

the OrderFulfillments which are associated with the given orderId

readByContextIdAndStatus

Optional<P> readByContextIdAndStatus(String id,
                                     String status,
                                     @Nullable
                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Reads the OrderFulfillment for the given id and status.

Parameters:

id - The ID of the OrderFulfillment

status - The OrderFulfillment.getStatus()

context - context information surrounding sandboxing and multitenant state

Returns:

Reads the OrderFulfillment for the given id and status.

readByContextIdAndMatchingTenant

Optional<P> readByContextIdAndMatchingTenant(String id,
                                             @Nullable
                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieves the order fulfillment matching the provided ID and the tenant from ContextInfo if present.

Differs from the standard narrowing behavior of CrudEntityService.readByContextId(String, ContextInfo), which only returns tenant-level (non-application-associated) records when fetching from a tenant context. This implementation finds all records within the tenant regardless of whether they're associated to an application.

Parameters:

id - the id of the order fulfillment to find

contextInfo - context information surrounding multitenant state

Returns:

an Optional containing the requested order fulfillment if found within the tenant, or Optional.empty() otherwise

readAllByOrderIdAndMatchingTenant

List<P> readAllByOrderIdAndMatchingTenant(String orderId,
                                          @Nullable
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieves the order fulfillment matching the provided ID and the tenant from ContextInfo if present.

Differs from the standard narrowing behavior of readAllByOrderId(String, ContextInfo), which only returns tenant-level (non-application-associated) records when fetching from a tenant context. This implementation finds all records within the tenant regardless of whether they're associated to an application.

Parameters:

orderId - The ID of the order to find fulfillments for

contextInfo - context information surrounding multitenant state

Returns:

the fulfillments that are associated with the given orderId

readAllMatchingTenant

org.springframework.data.domain.Page<P> readAllMatchingTenant(cz.jirutka.rsql.parser.ast.Node filters,
                                                              org.springframework.data.domain.Pageable pageable,
                                                              @Nullable
                                                              com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieves the order fulfillments matching the provided filters and the tenant from ContextInfo if present.

Differs from the standard narrowing behavior of {@link OrderFulfillmentService#readAll(Node, Pageable, ContextInfo), which only returns tenant-level (non-application-associated) records when fetching from a tenant context. This implementation finds all records within the tenant regardless of whether they're associated to an application.

Parameters:

id - the id of the order fulfillment to find

contextInfo - context information surrounding multitenant state

Returns:

an Optional containing the requested order fulfillment if found within the tenant, or Optional.empty() otherwise

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)

Retrieves the order fulfillments matching the provided groupReferenceNumber and filters.

Parameters:

groupReferenceNumber - the group reference number to match on

filters - An RSQL filter used to narrow query results. May be EmptyNode if no filters should be applied.

pageable - the requested page of results from the database

contextInfo - context information surrounding multitenant state

Returns:

A page of fulfillments that are associated with the given groupReferenceNumber

readAllByGroupReferenceNumberAndMatchingTenant

org.springframework.data.domain.Page<P> readAllByGroupReferenceNumberAndMatchingTenant(String groupReferenceNumber,
                                                                                       cz.jirutka.rsql.parser.ast.Node filters,
                                                                                       org.springframework.data.domain.Pageable pageable,
                                                                                       @Nullable
                                                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieves the order fulfillments matching the provided groupReferenceNumber and filters, and the tenant from ContextInfo if present.

Parameters:

groupReferenceNumber - the group reference number to match on

filters - An RSQL filter used to narrow query results. May be EmptyNode if no filters should be applied.

pageable - the requested page of results from the database

contextInfo - context information surrounding multitenant state

Returns:

A page of fulfillments that are associated with the given groupReferenceNumber