Package com.broadleafcommerce.content.service

Interface ContentZoneService<P extends ContentZone>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultContentZoneService
public interface ContentZoneService<P extends ContentZone> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
Service responsible for ContentZones CRUD operations.
Author:
Nathan Moore (nathandmoore)

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    hydrateContentItems(org.springframework.data.domain.Page<P> zones, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Hydrates the ContentItems for the ContentZoneItems.
    void
    hydrateContentItems(P zone, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Hydrates the ContentItems for the ContentZoneItems.
    org.springframework.data.domain.Page<P>
    readAllByName(String name, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Reads a page of ContentZones with a name filter.
    Optional<P>
    readByName(String name, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves the zone by 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

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

    readAll, readAll, readAll, readAll

  • Method Details

    • readAllByName

      org.springframework.data.domain.Page<P> readAllByName(@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 context)
      Reads a page of ContentZones with a name filter.
      Parameters:
      name - Name to filter by
      filters - Additional field filters
      page - Pagination parameters
      context - Additional sandbox and multitenant information
      Returns:
      A page of ContentZones with a name filter applied.

    • readByName

      Optional<P> readByName(String name, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves the zone by name.
      Parameters:
      name - The name of the zone.
      contextInfo - Additional sandbox and multitenant information
      Returns:
      The zone matching name or Optional.empty().

    • hydrateContentItems

      void hydrateContentItems(P zone, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Hydrates the ContentItems for the ContentZoneItems.
      Parameters:
      zone - ContentZone to hydrate
      contextInfo - Additional sandbox and multitenant info

    • hydrateContentItems

      void hydrateContentItems(org.springframework.data.domain.Page<P> zones, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Hydrates the ContentItems for the ContentZoneItems.
      Parameters:
      zones - Page of ContentZones to hydrate
      contextInfo - Additional sandbox and multitenant info