Package com.broadleafcommerce.search.index.fulfillment.service

Interface OrderFulfillmentService<P extends com.broadleafcommerce.search.fulfillment.core.domain.OrderFulfillment>

All Known Implementing Classes:

DefaultOrderFulfillmentService

public interface OrderFulfillmentService<P extends com.broadleafcommerce.search.fulfillment.core.domain.OrderFulfillment>

Service to interact with Order service to retrieve order fulfillments for indexing.

Author:

Dima Myroniuk (dmyroniuk)

Method Summary

Modifier and Type	Method	Description
List<String>	readBatchOfOrderFulfillmentIds(String startId, int batchSize)	Deprecated. in favor of readBatchOfOrderFulfillmentIds(String, int, Map<String, Object>) for the potential to utilize a time range when reading orders.
List<String>	readBatchOfOrderFulfillmentIds(String startId, int batchSize, Map<String,Object> additionalProperties)	Reads a batch of IDs to be placed in a queue for processing.
List<P>	readBatchOfOrderFulfillments(List<String> ids)	Reads a batch of Order fulfillments by their IDs.
Optional<P>	readOrderFulfillmentByContextId(String contextId)	Reads an OrderFulfillment by its ID.
List<P>	readOrderFulfillmentsByOrderId(String orderId)	Reads a batch of Order fulfillments by order ID.

Method Details

readBatchOfOrderFulfillmentIds

@Deprecated(since="2.1.2-GA")
List<String> readBatchOfOrderFulfillmentIds(String startId,
 int batchSize)
                                     throws com.broadleafcommerce.search.api.SearchIndexException

Deprecated.

in favor of readBatchOfOrderFulfillmentIds(String, int, Map<String, Object>) for the potential to utilize a time range when reading orders.

Throws:

com.broadleafcommerce.search.api.SearchIndexException

readBatchOfOrderFulfillmentIds

List<String> readBatchOfOrderFulfillmentIds(String startId,
 int batchSize,
 @Nullable
 Map<String,Object> additionalProperties)
                                     throws com.broadleafcommerce.search.api.SearchIndexException

Reads a batch of IDs to be placed in a queue for processing. Additional properties can also be specified to limit the items being read to be indexed.

Parameters:

startId - The starting ID

batchSize - The size of the batch

additionalProperties - additional information that can be used to filter the items to be indexed

Returns:

A list of order fulfillment IDs.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the order fulfillment ids fails.

readBatchOfOrderFulfillments

List<P> readBatchOfOrderFulfillments(List<String> ids)
                              throws com.broadleafcommerce.search.api.SearchIndexException

Reads a batch of Order fulfillments by their IDs.

Parameters:

ids - A list of order fulfillment IDs.

Returns:

A list of order fulfillments or an empty list.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the order fulfillment fails.

readOrderFulfillmentsByOrderId

List<P> readOrderFulfillmentsByOrderId(String orderId)
                                throws com.broadleafcommerce.search.api.SearchIndexException

Reads a batch of Order fulfillments by order ID.

Parameters:

orderId - an order ID.

Returns:

A list of order fulfillments or an empty list.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the order fulfillment fails.

readOrderFulfillmentByContextId

Optional<P> readOrderFulfillmentByContextId(String contextId)
                                     throws com.broadleafcommerce.search.api.SearchIndexException

Reads an OrderFulfillment by its ID.

Parameters:

contextId - An order fulfillment id

Returns:

An order fulfillment optional or Optional.empty()

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the order fulfillment fails.