DataDrivenEnumDetailsService (Broadleaf Catalog Services 2.1.1-GA API)

All Known Implementing Classes:: DefaultDataDrivenEnumDetailsService

public interface DataDrivenEnumDetailsService

This service is responsible for retrieving DataDrivenEnumDetails for DataDrivenEnumDetailsRequests, and for gathering additional information for DataDrivenEnumDetails, such as checking for an associated category.

Author:: Sunny Yu

Method Summary

Modifier and Type

Method

Description

boolean

checkAssociatedCategoryExists(DataDrivenEnumDetails dataDrivenEnumDetails, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Checks if an associated category exists based on the expected category url for the given DataDrivenEnumDetails.getValue().

Optional<DataDrivenEnumDetailsList>

getDataDrivenEnumDetailsForRequest(DataDrivenEnumDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets a DataDrivenEnumDetails for the DataDrivenEnumDetailsRequest.

Method Details
- getDataDrivenEnumDetailsForRequest
  
  Optional<DataDrivenEnumDetailsList> getDataDrivenEnumDetailsForRequest(DataDrivenEnumDetailsRequest request, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Gets a DataDrivenEnumDetails for the DataDrivenEnumDetailsRequest.
  
  Parameters:
  
  request - the DataDrivenEnumDetailsRequest with additional request context for identifying the data driven enum for which to retrieve details and defining the how much detail to go into.
  
  contextInfo - context information surrounding sandboxing/multitenant state
  
  Returns:
  
  a DataDrivenEnumDetails for the DataDrivenEnumDetailsRequest.
  
  Throws:
  
  DataDrivenEnumDetailsRequestException - Thrown if the request is invalid such as missing the ID.
- checkAssociatedCategoryExists
  
  boolean checkAssociatedCategoryExists(DataDrivenEnumDetails dataDrivenEnumDetails, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
  
  Checks if an associated category exists based on the expected category url for the given DataDrivenEnumDetails.getValue().
  
  Parameters:
  
  dataDrivenEnumDetails - DataDrivenEnumDetails to check the associated category for
  
  contextInfo - context information surrounding sandboxing/multitenant state