Package com.broadleafcommerce.pricing.service

Interface FeeService<F extends Fee>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<F>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<F>
All Known Implementing Classes:
DefaultFeeService
public interface FeeService<F extends Fee> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<F>
Base service API for Fee. Backed by a FeeRepository.
Since:
Pricing Services 2.2.0, Release Train 2.3.0
Author:
Julia Lopez-Pozas (jlopezpozas)

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    existsByFeeCode(String feeCode, String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Whether there exists a Fee where the Fee.getFeeCode() matches feeCode and the Fee.getId() does not match id.
    String
    getRepositoryDomain()
     
    List<F>
    readAllByApplicationId(String applicationId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Fetches and returns all Fees that exist in an application that matches the given application ID.
    org.springframework.data.domain.Page<F>
    readAllByLabel(String label, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all Fees that match the given label.

    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

    • readAllByApplicationId

      List<F> readAllByApplicationId(@NonNull String applicationId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Fetches and returns all Fees that exist in an application that matches the given application ID.
      Parameters:
      applicationId - the application ID to use for matching when fetching fees
      contextInfo - context information surrounding sandboxing and multitenant state
      Returns:
      a list of Fees that exist in an application that matches the given application ID
      Since:
      Pricing Services 2.2.0, Release Train 2.3.0

    • existsByFeeCode

      boolean existsByFeeCode(@NonNull String feeCode, @Nullable String id, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Whether there exists a Fee where the Fee.getFeeCode() matches feeCode and the Fee.getId() does not match id.
      Parameters:
      feeCode - The fee code to match
      id - The id to not match
      context - context information surrounding sandboxing and multitenant state
      Returns:
      Whether there exists a Fee where the Fee.getFeeCode() matches feeCode and the Fee.getId() does not match id.
      Since:
      Pricing Services 2.2.0, Release Train 2.3.0

    • readAllByLabel

      org.springframework.data.domain.Page<F> readAllByLabel(@Nullable String label, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all Fees that match the given label.
      Parameters:
      label - the fee label 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
      context - context information surrounding sandboxing and multitenant state
      Returns:
      all fees that match the given label
      Since:
      Pricing Services 2.2.0, Release Train 2.3.0

    • getRepositoryDomain

      @NonNull String getRepositoryDomain()