Interface CatalogProvider
- All Known Implementing Classes:
ExternalCatalogProvider
public interface CatalogProvider
Component to allow us to interact with a CatalogService to fetch IDs and Products for collection.
- Author:
- Kelly Tisdell (ktisdell)
-
Method Summary
Modifier and TypeMethodDescriptionreadIdBatchForFullFeed(String cursor, int batchSize, String filterString, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Reads a batch of Product IDs, in ascending order, starting at the cursor.readIdBatchForPartialFeed(@NonNull List<IncrementalDataFeedEntityUpdateRecord> updateRecords, String filterString, com.broadleafcommerce.data.tracking.core.context.ContextInfo readContextInfo) Given a batch ofIncrementalDataFeedEntityUpdateRecords, fetch Product IDs that correspond.readProducts(@NonNull List<String> idBatch, com.broadleafcommerce.data.tracking.core.context.ContextInfo readContextInfo) Reads a batch ofCollectedProductsfrom the batch of provided IDs.
-
Method Details
-
readIdBatchForPartialFeed
List<String> readIdBatchForPartialFeed(@NonNull @NonNull List<IncrementalDataFeedEntityUpdateRecord> updateRecords, @Nullable String filterString, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo readContextInfo) Given a batch ofIncrementalDataFeedEntityUpdateRecords, fetch Product IDs that correspond.- Parameters:
updateRecords- a list of records with references to products and their IDsfilterString- a RSQL filter string, or nullreadContextInfo- theContextInfofor reading the IDs- Returns:
-
readIdBatchForFullFeed
List<String> readIdBatchForFullFeed(@Nullable String cursor, int batchSize, @Nullable String filterString, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Reads a batch of Product IDs, in ascending order, starting at the cursor.- Parameters:
cursor- the last ID fetched, or nullbatchSize- the number of IDs to fetch in a batchfilterString- a RSQL filter string, or nullcontextInfo- theContextInfofor reading the IDs- Returns:
-
readProducts
List<CollectedProduct> readProducts(@NonNull @NonNull List<String> idBatch, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo readContextInfo) Reads a batch ofCollectedProductsfrom the batch of provided IDs.- Parameters:
idBatch- batch of IDs for which to fetch productsreadContextInfo- contextInfo theContextInfofor reading the IDs- Returns:
-