Package com.broadleafcommerce.audit.service

Interface AuditService<P extends AuditHeader,Q extends AuditDetail>

Type Parameters:
P - The possibly extended projection type for headers
Q - The possibly extended projection type for details
All Known Implementing Classes:
DefaultAuditService
public interface AuditService<P extends AuditHeader,Q extends AuditDetail>
Handles endpoint fetch operations for viewing audit information

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.data.domain.Page<Q>
    readAllDetailsByHeader(String headerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all details for a given header
    org.springframework.data.domain.Page<Q>
    readAllDetailsByHeaderAndAccount(String headerId, String accountId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all details for a given header
    org.springframework.data.domain.Page<Q>
    readAllDetailsByHeaderAndCustomer(String headerId, String customerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all details for a given header
    org.springframework.data.domain.Page<P>
    readAllHeaders(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all headers across all available audits
    org.springframework.data.domain.Page<P>
    readAllHeadersByAccount(String accountId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all headers for a given account
    org.springframework.data.domain.Page<P>
    readAllHeadersByCustomer(String customerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Read all headers for a given customer

  • Method Details

    • readAllHeaders

      org.springframework.data.domain.Page<P> readAllHeaders(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all headers across all available audits
      Parameters:
      filters - RSQL filters to apply
      pageable - Paging configuration
      context - DataTracking tenant context information
      Returns:
      The page of results

    • readAllHeadersByAccount

      org.springframework.data.domain.Page<P> readAllHeadersByAccount(String accountId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all headers for a given account
      Parameters:
      accountId - The account to filter results by
      filters - Additional RSQL filters to apply
      pageable - Paging configuration
      context - DataTracking tenant context information
      Returns:
      The page of results

    • readAllHeadersByCustomer

      org.springframework.data.domain.Page<P> readAllHeadersByCustomer(String customerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all headers for a given customer
      Parameters:
      customerId - The customer to filter results by
      filters - Additional RSQL filters to apply
      pageable - Paging configuration
      context - DataTracking tenant context information
      Returns:
      The page of results

    • readAllDetailsByHeader

      org.springframework.data.domain.Page<Q> readAllDetailsByHeader(String headerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all details for a given header
      Parameters:
      headerId - The header id to filter details by
      filters - Additional RSQL filters to apply
      pageable - Paging configuration
      context - DataTracking tenant context information
      Returns:
      The page of results

    • readAllDetailsByHeaderAndAccount

      org.springframework.data.domain.Page<Q> readAllDetailsByHeaderAndAccount(String headerId, String accountId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all details for a given header
      Parameters:
      headerId - The header id to filter details by
      accountId - The account to filter results by
      filters - Additional RSQL filters to apply
      pageable - Paging configuration
      context - DataTracking tenant context information
      Returns:
      The page of results

    • readAllDetailsByHeaderAndCustomer

      org.springframework.data.domain.Page<Q> readAllDetailsByHeaderAndCustomer(String headerId, String customerId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Read all details for a given header
      Parameters:
      headerId - The header id to filter details by
      customerId - The customer to filter results by
      filters - Additional RSQL filters to apply
      pageable - Paging configuration
      context - DataTracking tenant context information
      Returns:
      The page of results