Package com.broadleafcommerce.catalog.service.category.commerce

Interface CategoryDetailsService

All Known Implementing Classes:

DefaultCategoryDetailsService

public interface CategoryDetailsService

This service is responsible for retrieving CategoryDetails for CategoryDetailsRequests. It is responsible for building the details; however, it typically should defer the hydration of the related domain to the available CategoryDetailsContributors.

Author:

Nathan Moore (nathandmoore)

Method Summary

Modifier and Type	Method	Description
CategoryDetails	getCategoryDetailsForCategory(CategoryDetailsRequest request, Category category, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a CategoryDetails for the CategoryDetailsRequest.
Optional<CategoryDetails>	getCategoryDetailsForRequest(CategoryDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a CategoryDetails for the CategoryDetailsRequest.

Method Details

getCategoryDetailsForRequest

Optional<CategoryDetails> getCategoryDetailsForRequest(CategoryDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets a CategoryDetails for the CategoryDetailsRequest.

Parameters:

request - the CategoryDetailsRequest with additional request context for identifying the category for which to retrieve details and defining the how much detail to go into.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

a CategoryDetails for the CategoryDetailsRequest.

Throws:

CategoryDetailsRequestException - Thrown if the request is invalid such as missing both the category URI and ID.

getCategoryDetailsForCategory

CategoryDetails getCategoryDetailsForCategory(CategoryDetailsRequest request,
 Category category,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets a CategoryDetails for the CategoryDetailsRequest.

Parameters:

request - The originating CategoryDetailsRequest

category - the Category for which to build a CategoryDetails.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

a CategoryDetails for the CategoryDetailsRequest.