Package com.broadleafcommerce.catalog.service.tag

Interface AdvancedTagService<P extends AdvancedTag>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultAdvancedTagService
public interface AdvancedTagService<P extends AdvancedTag> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
Service API for Tags. Supported by TagRepository.
Author:
Nathan Moore (nathandmoore)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRepositoryDomain()
    Returns the name of the repository domain corresponding to the projection domain.
    List<P>
    readAllByIdIn(Iterable<String> ids, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all of the tags with matching ids.
    org.springframework.data.domain.Page<P>
    readAllByNameLike(String name, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Read all tags filtered by name.
    List<P>
    readAllByPosition(String position, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all of the tags with matching position.
    List<P>
    readAllByType(String type, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all of the tags with matching type.
    List<P>
    readAllByTypeAndPosition(String type, String position, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all of the tags with matching type and position.
    Optional<P>
    readByNameExact(String name, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Finds the tag by name, which should be unique.

    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

    • readByNameExact

      Optional<P> readByNameExact(String name, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Finds the tag by name, which should be unique.
      Parameters:
      name - The name of the tag
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      The tag matching the name if any.

    • readAllByNameLike

      org.springframework.data.domain.Page<P> readAllByNameLike(@Nullable String name, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Read all tags filtered by name.
      Parameters:
      name - The name to filter by
      filters - additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.
      page - the requested page of results from the database
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      all tags filtered by name.

    • readAllByIdIn

      List<P> readAllByIdIn(Iterable<String> ids, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all of the tags with matching ids.
      Parameters:
      ids - The ids to match
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      All of the tags with matching ids.

    • readAllByPosition

      List<P> readAllByPosition(String position, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all of the tags with matching position.
      Parameters:
      position - The position to match
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      All of the tags with matching position.

    • readAllByType

      List<P> readAllByType(String type, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all of the tags with matching type.
      Parameters:
      type - The position to match
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      All of the tags with matching type.

    • readAllByTypeAndPosition

      List<P> readAllByTypeAndPosition(String type, String position, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all of the tags with matching type and position.
      Parameters:
      type - The position to match
      position - The position to match
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      All of the tags with matching type and position.

    • 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.