Package com.broadleafcommerce.datafeed.service

Interface DataFeedProcessService<P extends DataFeedProcess>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultDataFeedProcessService
public interface DataFeedProcessService<P extends DataFeedProcess> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
Service API for DataFeedProcess. Supported by DataFeedProcessRepository.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 the DataFeedProcess instances that matched the given name and filters.
    Optional<P>
    readByContextIdOpt(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Similar to CrudEntityService.readByContextId(String, ContextInfo), but returns an Optional instead of throwing EntityMissingException when not found.
    List<P>
    readByProcessTypeAndEnabledAndApplication(String processType, boolean isEnabled, String applicationId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Finds all DataFeedProcess instances matching the given criteria.

    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 the DataFeedProcess instances that matched the given name and filters.
      Parameters:
      name - the data feed process name
      filters - the RSQL Node used to restrict result
      page - the requested page of results from the database
      context - context information around multitenant state
      Returns:
      the DataFeedProcess instances that matched the given name and filters

    • readByContextIdOpt

      Optional<P> readByContextIdOpt(String id, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Similar to CrudEntityService.readByContextId(String, ContextInfo), but returns an Optional instead of throwing EntityMissingException when not found.
      Parameters:
      id - The context id for the entity. This is the id by which the business recognizes the item.
      context - Context information used to discriminate the correct version of an entity by context id when multiple verions may be available across sandboxes, catalogs and applications.
      Returns:
      an Optional containing the narrowed entity instance in the form of a business instance, else Optional.empty()

    • readByProcessTypeAndEnabledAndApplication

      List<P> readByProcessTypeAndEnabledAndApplication(String processType, boolean isEnabled, @Nullable String applicationId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Finds all DataFeedProcess instances matching the given criteria.
      Parameters:
      processType - the DataFeedProcess.getProcessType() to match
      isEnabled - the value of DataFeedProcess.isEnabled() to match
      applicationId - (optional) if provided, results will be filtered to only those who match the given DataFeedProcess.getApplicationId()
      contextInfo - context information around multitenant state
      Returns:
      a list of found results