Namespace: Consultingwerk.Framework.Base
Class 
ValueObjectCache Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Framework.Base.ValueObjectCacheBase

File:ValueObjectCache
Purpose:Abstract base class for Value Object Cache implementations
Description:Caches value objects for a specified amount of time (seconds)
and flushes objects aged too much from the cache. Objects
are stored based on a character key
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Dec 27 20:41:41 CET 2018



Top Method Summary
Options Name Purpose
+ Progress.Lang.Object GetCachedObject (character) Returns a cached objet
# Progress.Lang.Object GetCachedObjectInternal (character) Returns a cached objet
Inherited from Consultingwerk.Framework.Base.ValueObjectCacheBase
+ StoreObject (character, Object) Stores an object in the cache
# StoreObjectInternal (character, Object) Stores an object in the cache
Inherited from Consultingwerk.Framework.Base.ValueObjectCacheBase

Top Constructor Summary
Options Name Purpose
+ ValueObjectCache (integer) Constructor for the ValueObjectCache class

Top Property Summary
Options Name Purpose
+ INTEGER MaxCacheAge
Inherited from Consultingwerk.Framework.Base.ValueObjectCacheBase


Method Detail
Top

PUBLIC Progress.Lang.Object GetCachedObject (character)

Purpose: Returns a cached objet
Notes:

Parameters:
pcCacheKey CHARACTER
The key under which the object is stored
Returns Progress.Lang.Object
The reference to the cached object or ? when the object is either not cached or the cache is outdated
Top

PROTECTED Progress.Lang.Object GetCachedObjectInternal (character)

Inherited from Consultingwerk.Framework.Base.ValueObjectCacheBase
Purpose: Returns a cached objet
Notes:

Parameters:
pcCacheKey CHARACTER
The key under which the object is stored
Returns Progress.Lang.Object
The reference to the cached object or ? when the object is either not cached or the cache is outdated
Top

PUBLIC StoreObject (character, Object)

Purpose: Stores an object in the cache
Notes:

Parameters:
pcCacheKey CHARACTER
The key under which the object should be stored
poObject Progress.Lang.Object
The reference to the value object to be stored
Top

PROTECTED StoreObjectInternal (character, Object)

Inherited from Consultingwerk.Framework.Base.ValueObjectCacheBase
Purpose: Stores an object in the cache
Notes:

Parameters:
pcCacheKey CHARACTER
The key under which the object should be stored
poObject Progress.Lang.Object
The reference to the value object to be stored


Constructor Detail
Top

PUBLIC ValueObjectCache (integer)

Purpose: Constructor for the ValueObjectCache class
Notes:

Parameters:
piMaxCacheAge INTEGER
The number of seconds objects should remain cached


Property Detail
Top

PUBLIC INTEGER MaxCacheAge

Inherited from Consultingwerk.Framework.Base.ValueObjectCacheBase

Returns INTEGER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:11:52