Package org.flowable.common.engine.impl.persistence.cache

Interface CachedEntityMatcher<EntityImpl extends Entity>

All Known Implementing Classes:
ActivityByProcessInstanceIdMatcher, ActivityInstanceMatcher, CachedEntityMatcherAdapter, CaseInstanceByCaseDefinitionIdMatcher, DeadLetterJobsByExecutionIdMatcher, EntityLinksByRootScopeIdAndTypeMatcher, EntityLinksByScopeIdAndTypeMatcher, EntityLinksWithSameRootScopeForScopeIdAndScopeTypeMatcher, EventSubscriptionsByExecutionAndTypeMatcher, EventSubscriptionsByExecutionIdMatcher, EventSubscriptionsByNameMatcher, EventSubscriptionsByProcessDefinitionIdAndProcessStartEventMatcher, EventSubscriptionsByProcessInstanceAndTypeMatcher, EventSubscriptionsByProcInstTypeAndActivityMatcher, EventSubscriptionsByScopeDefinitionIdAndScopeStartEventMatcher, EventSubscriptionsByScopeDefinitionIdAndTypeAndNullScopeIdMatcher, EventSubscriptionsByScopeDefinitionIdAndTypeMatcher, EventSubscriptionsByScopeIdAndTypeMatcher, EventSubscriptionsBySubScopeIdMatcher, ExecutionByProcessInstanceMatcher, ExecutionsByParentExecutionIdAndActivityIdEntityMatcher, ExecutionsByParentExecutionIdEntityMatcher, ExecutionsByProcessInstanceIdEntityMatcher, ExecutionsByRootProcessInstanceMatcher, ExecutionsWithSameRootProcessInstanceIdMatcher, ExternalWorkerJobsByExecutionIdMatcher, ExternalWorkerJobsByScopeIdAndSubScopeIdMatcher, HistoricActivityInstanceMatcher, HistoricCaseInstanceByCaseDefinitionIdMatcher, HistoricDetailsByProcessInstanceIdEntityMatcher, HistoricDetailsByTaskInstanceIdEntityMatcher, HistoricIdentityLinksByProcInstMatcher, HistoricIdentityLinksByScopeIdAndTypeMatcher, HistoricIdentityLinksBySubScopeIdAndTypeMatcher, HistoricVariableInstanceByProcInstMatcher, HistoricVariableInstanceByScopeIdAndScopeTypeMatcher, HistoricVariableInstanceBySubScopeIdAndScopeTypeMatcher, HistoricVariableInstanceByTaskIdMatcher, IdentityLinksByProcessInstanceMatcher, IdentityLinksByProcessInstanceUserGroupAndTypeMatcher, IdentityLinksByScopeIdAndTypeMatcher, IdentityLinksByScopeIdScopeTypeUserGroupAndTypeMatcher, IdentityLinksBySubScopeIdAndTypeMatcher, IdentityLinksByTaskIdMatcher, InactiveExecutionsByProcInstMatcher, InactiveExecutionsInActivityAndProcInstMatcher, InactiveExecutionsInActivityMatcher, InternalEntityLinkQueryImpl, InternalVariableInstanceQueryImpl, JobsByExecutionIdMatcher, MessageEventSubscriptionsByProcInstAndEventNameMatcher, MybatisMilestoneInstanceDataManager.MilestoneInstanceByCaseInstanceIdCachedEntityMatcher, MybatisPlanItemInstanceDataManagerImpl.PlanItemInstanceByCaseInstanceIdAndPlanItemIdCachedEntityMatcher, MybatisPlanItemInstanceDataManagerImpl.PlanItemInstanceByCaseInstanceIdCachedEntityMatcher, MybatisPlanItemInstanceDataManagerImpl.PlanItemInstanceByStageInstanceIdAndPlanItemIdCachedEntityMatcher, MybatisPlanItemInstanceDataManagerImpl.PlanItemInstanceByStagePlanItemInstanceIdCachedEntityMatcher, MybatisSentryPartInstanceDataManagerImpl.SentryPartByCaseInstanceIdEntityMatcher, MybatisSentryPartInstanceDataManagerImpl.SentryPartByPlanItemInstanceIdEntityMatcher, ProcessInstancesByProcessDefinitionMatcher, SignalEventSubscriptionByEventNameMatcher, SignalEventSubscriptionByNameAndExecutionMatcher, SignalEventSubscriptionByProcInstAndEventNameMatcher, SignalEventSubscriptionByScopeAndEventNameMatcher, SignalEventSubscriptionByScopeIdAndTypeMatcher, SuspendedJobsByExecutionIdMatcher, TasksByExecutionIdMatcher, TasksByProcessInstanceIdMatcher, TasksByScopeIdAndScopeTypeMatcher, TasksBySubScopeIdAndScopeTypeMatcher, TimerJobsByExecutionIdMatcher, TimerJobsByScopeIdAndSubScopeIdMatcher, UnfinishedActivityInstanceMatcher, UnfinishedHistoricActivityInstanceByProcessInstanceIdMatcher, UnfinishedHistoricActivityInstanceMatcher, VariableInstanceByExecutionIdMatcher, VariableInstanceByScopeIdAndScopeTypeMatcher, VariableInstanceByScopeIdAndScopeTypesMatcher, VariableInstanceBySubScopeIdAndScopeTypesMatcher, VariableInstanceByTaskIdMatcher
public interface CachedEntityMatcher<EntityImpl extends Entity>
Interface to express a condition whether or not a cached entity should be used in the return result of a query.
Author:
Joram Barrez

  • Method Details

    • isRetained

      boolean isRetained(Collection<EntityImpl> databaseEntities, Collection<CachedEntity> cachedEntities, EntityImpl entity, Object param)
      Returns true if an entity from the cache should be retained (i.e. used as return result for a query). Most implementations of this interface probably don't need this method, and should extend the simpler CachedEntityMatcherAdapter, which hides this method. Note that the databaseEntities collection can be null, in case only the cache is checked.