Package com.broadleafcommerce.promotion.campaign.service

Interface CampaignService<P extends Campaign>

  • All Superinterfaces:
    com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
    All Known Implementing Classes:
    DefaultCampaignService
    public interface CampaignService<P extends Campaign>
extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
    Base service API for Campaign. Backed by a CampaignRepository.
    Author:
    Chad Harchar (charchar)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean existsById​(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns whether the campaign with the given id exists in the data store
      boolean existsByIdAndActive​(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns whether the campaign with the given id exists and is active in the data store.
      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)  

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

      • readAllByName

        @NonNull
org.springframework.data.domain.Page<P> readAllByName​(@NonNull
                                                      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)

      • existsById

        boolean existsById​(String id,
                   @Nullable
                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Returns whether the campaign with the given id exists in the data store
        Parameters:
        id - the id of the campaign to find
        contextInfo - context information surrounding sandboxing and multi tenant state
        Returns:
        whether the campaign with the given id exists in the data store

      • existsByIdAndActive

        boolean existsByIdAndActive​(@NonNull
                            String id,
                            @Nullable
                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
        Returns whether the campaign with the given id exists and is active in the data store.
        Parameters:
        id - the id of the campaign to find
        contextInfo - context information surrounding sandboxing and multi tenant state
        Returns:
        whether the campaign with the given id exists and is active in the data store