Top Method Summary
Options Name Purpose
Clear () Discards all cached results
PruneExpired () Removes the entries that have expired
PutResult (EntitySearchQuery) Stores the result of the given query in the cache
Remove (character) Removes the entry with the given cache key, and its rows
LOGICAL TryGetResult (EntitySearchQuery) Fills the rows of the given query from the cache, when a result that has not expired yet is held for it


Method Detail
Top

Clear ()

Purpose: Discards all cached results
Notes:

Top

PruneExpired ()

Purpose: Removes the entries that have expired
Notes: Called by the owning service on every search, so a long
running session does not accumulate stale entries

Top

PutResult (EntitySearchQuery)

Purpose: Stores the result of the given query in the cache
Notes: A query that opted out of caching, or that came back with an
error, is not cached

Parameters:
poQuery Consultingwerk.SmartFramework.Search.EntitySearchQuery
The query whose result is to be cached
Top

Remove (character)

Purpose: Removes the entry with the given cache key, and its rows
Notes:

Parameters:
pcCacheKey CHARACTER
The cache key of the entry to remove
Top

LOGICAL TryGetResult (EntitySearchQuery)

Purpose: Fills the rows of the given query from the cache, when a
result that has not expired yet is held for it
Notes: Queries that opted out of caching (CacheSeconds of 0) always
miss

Parameters:
poQuery Consultingwerk.SmartFramework.Search.EntitySearchQuery
The query to answer from the cache
Returns LOGICAL
TRUE when the query was answered from the cache


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:15:15