Package com.broadleafcommerce.search.core.service

Interface TypeAheadConfigurationService<P extends com.broadleafcommerce.search.api.domain.TypeAheadConfiguration>

  • All Superinterfaces:
    com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>
    All Known Implementing Classes:
    DefaultTypeAheadConfigurationService
    public interface TypeAheadConfigurationService<P extends com.broadleafcommerce.search.api.domain.TypeAheadConfiguration>
extends com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      P hydrateConfiguration​(P typeAheadConfiguration, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Hydrate any nested fields in the TypeAheadConfiguration.
      Optional<P> readByName​(String configName, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns a TypeAheadConfiguration with the given name.

      • Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

        create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

    • Method Detail

      • readByName

        Optional<P> readByName​(String configName,
                       @Nullable
                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Returns a TypeAheadConfiguration with the given name.
        Parameters:
        configName - The name of the configuration
        contextInfo - context information surrounding sandboxing/multitenant state
        Returns:
        The configuration matching the name or null if not found.

      • hydrateConfiguration

        P hydrateConfiguration​(P typeAheadConfiguration,
                       @Nullable
                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Hydrate any nested fields in the TypeAheadConfiguration.
        Parameters:
        typeAheadConfiguration - Configuration to hydrate
        contextInfo - context information surrounding sandboxing/multitenant state
        Returns:
        Hydrated configuration