Package com.broadleafcommerce.search.core.service.searchsettings

Interface SearchSettingsService<P extends com.broadleafcommerce.search.api.domain.SearchSettings>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultSearchSettingsService
public interface SearchSettingsService<P extends com.broadleafcommerce.search.api.domain.SearchSettings> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRepositoryDomain()
    Returns the name of the repository domain corresponding to the projection domain.
    Optional<com.broadleafcommerce.search.api.domain.SearchSettings>
    readBySettingsContext(String settingsContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads the search settings for the provided settings context.
    Optional<com.broadleafcommerce.search.api.domain.SearchSettings>
    resolveForContext(String settingsContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

    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

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

    readAll, readAll, readAll, readAll

  • Method Details

    • readBySettingsContext

      Optional<com.broadleafcommerce.search.api.domain.SearchSettings> readBySettingsContext(String settingsContext, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads the search settings for the provided settings context.
      Parameters:
      settingsContext - the settings context to filter on, see DefaultSettingsContextType
      contextInfo - context surrounding sandboxing and multitenant state
      Returns:
      the search settings for the provided settings context

    • resolveForContext

      Optional<com.broadleafcommerce.search.api.domain.SearchSettings> resolveForContext(String settingsContext, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • getRepositoryDomain

      String getRepositoryDomain()
      Returns the name of the repository domain corresponding to the projection domain.
      Returns:
      The name of the repository domain corresponding to the projection domain.