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 TypeMethodDescriptiongetCategoryDetailsForCategory
(CategoryDetailsRequest request, Category category, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Gets aCategoryDetails
for theCategoryDetailsRequest
.getCategoryDetailsForRequest
(CategoryDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Gets aCategoryDetails
for theCategoryDetailsRequest
.
-
Method Details
-
getCategoryDetailsForRequest
Optional<CategoryDetails> getCategoryDetailsForRequest(CategoryDetailsRequest request, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo) Gets aCategoryDetails
for theCategoryDetailsRequest
.- Parameters:
request
- theCategoryDetailsRequest
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 theCategoryDetailsRequest
. - 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 aCategoryDetails
for theCategoryDetailsRequest
.- Parameters:
request
- The originatingCategoryDetailsRequest
category
- theCategory
for which to build aCategoryDetails
.contextInfo
- context information surrounding sandboxing/multitenant state- Returns:
- a
CategoryDetails
for theCategoryDetailsRequest
.
-