logo
logo

Class EntityDefinitionCache

Caches definition in memory.

Constructors

EntityDefinitionCache()

Declaration
new EntityDefinitionCache()

Functions

load(definition)

Load the specified definition into the cache.

Declaration
function load(definition)
Parameters
Type Name Description
definition

The entity definition

get(key)

Retrieve the definition with specified name or id from the cache.

Declaration
function get(key)
Parameters
Type Name Description
key

The definition name or definition id

Returns
Type Description

The cached definition or null

loadAll(definitions, loadAllIndividually, loadAsGroup)

Loads all definitions into the cache.

Declaration
function loadAll(definitions, loadAllIndividually, loadAsGroup)
Parameters
Type Name Description
definitions

An array of entity definitions

loadAllIndividually

Flag indicating whether to load the definitions individually or not

loadAsGroup

Key to be used to store the array of definitions, or false to not load the array

getAll(group)

Retrieves an array of definitions that was cached with the specified group key.

Declaration
function getAll(group)
Parameters
Type Name Description
group

The key with which the group of definitions was stored

invalidate(key)

Invalidates/removes the definition with specified name or id from the cache.

Declaration
function invalidate(key)
Parameters
Type Name Description
key

The definition name or definition id

Can we improve this article ? Provide feedback