Package com.broadleafcommerce.order.provider.jpa.repository

Class JpaOrderTenantQueryHelper

  • public class JpaOrderTenantQueryHelper
extends Object
    Convenience methods to help query for JPA order-related entities matching a tenant context.

    • Constructor Summary

      Constructors 
      Constructor Description
      JpaOrderTenantQueryHelper​(com.broadleafcommerce.data.tracking.jpa.filtering.fetch.rsql.JpaFiltersCriteriaBuilder filtersCriteriaBuilder)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected javax.persistence.criteria.Predicate buildArchivedIsFalseFilter​(javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)  
      <D extends com.broadleafcommerce.data.tracking.core.Trackable>
      List<javax.persistence.criteria.Predicate>      		 buildContextFiltersIfApplicable​(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, javax.persistence.criteria.CriteriaQuery<D> criteria, Map<String,​Object> queryParams, javax.persistence.criteria.Root<D> entity, Class<D> managedType)
      Creates filters narrowing the context as an alternative to the narrowing of JpaNarrowExecutor.
      javax.persistence.criteria.Predicate buildContextIdIsEqualToFilter​(String contextId, Map<String,​Object> queryParams, javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)  
      javax.persistence.criteria.Predicate buildContextIdIsInFilter​(Iterable<String> contextIds, Map<String,​Object> queryParams, javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)  
      protected javax.persistence.criteria.Predicate buildTenantIdIsEqualToFilter​(String tenantId, Map<String,​Object> queryParams, javax.persistence.criteria.CriteriaBuilder criteriaBuilder, javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)  

    • Constructor Detail

      • JpaOrderTenantQueryHelper

        public JpaOrderTenantQueryHelper​(com.broadleafcommerce.data.tracking.jpa.filtering.fetch.rsql.JpaFiltersCriteriaBuilder filtersCriteriaBuilder)

    • Method Detail

      • buildContextIdIsEqualToFilter

        public javax.persistence.criteria.Predicate buildContextIdIsEqualToFilter​(String contextId,
                                                                          Map<String,​Object> queryParams,
                                                                          javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                                                                          javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)

      • buildContextIdIsInFilter

        public javax.persistence.criteria.Predicate buildContextIdIsInFilter​(Iterable<String> contextIds,
                                                                     Map<String,​Object> queryParams,
                                                                     javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                                                                     javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)

      • buildContextFiltersIfApplicable

        public <D extends com.broadleafcommerce.data.tracking.core.Trackable> List<javax.persistence.criteria.Predicate> buildContextFiltersIfApplicable​(@Nullable
                                                                                                                                                 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                                                                                                                                 javax.persistence.criteria.CriteriaQuery<D> criteria,
                                                                                                                                                 Map<String,​Object> queryParams,
                                                                                                                                                 javax.persistence.criteria.Root<D> entity,
                                                                                                                                                 Class<D> managedType)
        Creates filters narrowing the context as an alternative to the narrowing of JpaNarrowExecutor.

        Will only add filters on tenant, archived status, hints, influencers, and active dates. This cannot perform any catalog or application narrowing.

        Type Parameters:
        D - the entity type being queried for
        Parameters:
        contextInfo - context information surrounding multitenant state
        criteria - The current query being built up
        queryParams - contains parameters that will be set on the query
        entity - the query root entity
        managedType - the type being queried for
        Returns:
        filters narrowing the query by tenant, archival, hints, influencers, and active dates from context

      • buildTenantIdIsEqualToFilter

        protected javax.persistence.criteria.Predicate buildTenantIdIsEqualToFilter​(@Nullable
                                                                            String tenantId,
                                                                            Map<String,​Object> queryParams,
                                                                            javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                                                                            javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)

      • buildArchivedIsFalseFilter

        protected javax.persistence.criteria.Predicate buildArchivedIsFalseFilter​(javax.persistence.criteria.CriteriaBuilder criteriaBuilder,
                                                                          javax.persistence.criteria.Root<? extends com.broadleafcommerce.data.tracking.core.Trackable> entity)