Namespace: Consultingwerk.SmartFramework.System.SmartCache
Interface 
ISmartCacheService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.SmartFramework.System.SmartCache.SmartCacheService


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
LOGICAL ClearCache (CacheScopeEnum, character) Deletes all records for a scope type and scope key
LOGICAL ClearCache (datetime-tz) Deletes expired records from the cache
LOGICAL RetrieveDataset (character, dataset-handle) Retrieves a dataset from the cache
StoreDataset (character, dataset-handle, Duration) Adds a dataset to the cache
StoreDataset (character, dataset-handle, Duration, CacheScopeEnum, character) Adds a dataset to the cache


Method Detail
Top

LOGICAL ClearCache (CacheScopeEnum, character)
Purpose: Deletes all records for a scope type and scope key
Notes:

Parameters:
poCacheScopeType Consultingwerk.SmartFramework.System.SmartCache.CacheScopeEnum
The scope type
pcCacheScopeKey CHARACTER
The scope key
Returns LOGICAL
Returns TRUE if at least one record was deleted
Top

LOGICAL ClearCache (datetime-tz)
Purpose: Deletes expired records from the cache
Notes:

Parameters:
pdtzExpiryDate DATETIME-TZ
The date before which cached items are invalid
Returns LOGICAL
Returns TRUE if at least one record was deleted
Top

LOGICAL RetrieveDataset (character, dataset-handle)
Purpose: Retrieves a dataset from the cache
Notes:
Returns FALSE otherwise.

Parameters:
pcCacheKey CHARACTER
A (unique) key to find the dataset
phDataset DATASET-HANDLE
OUTPUT The ProDataSet to cache.
Returns LOGICAL
Returns TRUE if the requested dataset is in the cache, and is not stale.
Top

StoreDataset (character, dataset-handle, Duration)
Purpose: Adds a dataset to the cache
Notes: The dataset contents at the time that this method is called,
are cached. So if records in the dataset are updated in any way,
these changes will not be reflected in the cache.
instance is passed in, the cache has no expiry time

Parameters:
pcCacheKey CHARACTER
A (unique) key to find the dataset
phDataset DATASET-HANDLE
The ProDataSet to cache.
poDuration Consultingwerk.Duration
The duration a dataset is stored, before it is stale. If no duration
Top

StoreDataset (character, dataset-handle, Duration, CacheScopeEnum, character)
Purpose: Adds a dataset to the cache
Notes: The dataset contents at the time that this method is called,
are cached. So if records in the dataset are updated in any way,
these changes will not be reflected in the cache.
instance is passed in, the cache has no expiry time
for DatasetCacheScopeEnum:LoginSession, which uses the SessionManager's UserName.

Parameters:
pcCacheKey CHARACTER
A (unique) key to find the dataset
phDataset DATASET-HANDLE
The ProDataSet to cache.
poDuration Consultingwerk.Duration
The duration a dataset is stored, before it is stale. If no duration
poCacheScopeType Consultingwerk.SmartFramework.System.SmartCache.CacheScopeEnum
The scope for the cache
pcCacheScopeKey CHARACTER
A key for the cache scope. A free text value (incl. ?); not used


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:10:59