C# Class SobekCM.Core.MemoryMgmt.CachedDataManager_AggregationServices

Aggregation-related services for the Cached Data Manager, which allows aggregation objects, and closely related objects, to be cached locally for reuse

Afficher le fichier Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Méthodes publiques

Méthode	Description
CachedDataManager_AggregationServices ( SobekCM.Core.MemoryMgmt.CachedDataManager_Settings Settings ) : System	Constructor for a new instance of the CachedDataManager_AggregationServices class.
Clear ( ) : void	Clears all aggregation values from the cache
Clear_Aggregation_Hierarchy ( ) : void	Clear the aggregation hierarchy object from the cache
Remove_Item_Aggregation ( string Aggregation_Code, Custom_Tracer Tracer ) : void	Removes all references to a particular item aggregation from the cache
Retrieve_Aggregation_HTML_Based_Content ( string Aggregation_Code, Web_Language_Enum Language, string ChildPageCode, Custom_Tracer Tracer ) : HTML_Based_Content	Retrieve the aggregation-level static HTML browse object, including the text itself, from the cache
Retrieve_Aggregation_Hierarchy ( Custom_Tracer Tracer ) : SobekCM.Core.Aggregations.Aggregation_Hierarchy	Retrieves the item aggregation hierarchy from the cache
Retrieve_Complete_Item_Aggregation ( string Aggregation_Code, Custom_Tracer Tracer ) : Complete_Item_Aggregation	Retrieves the complete item aggregation obejct from the cache
Retrieve_Item_Aggregation ( string AggregationCode, Web_Language_Enum Language, Custom_Tracer Tracer ) : Item_Aggregation	Retrieves the item aggregation obejct from the cache
Store_Aggregation_HTML_Based_Content ( string Aggregation_Code, Web_Language_Enum Language, string ChildPageCode, HTML_Based_Content StoreObject, Custom_Tracer Tracer ) : void	Store_s the content of the aggregation_ HTM l_ based_.
Store_Aggregation_Hierarchy ( SobekCM.Core.Aggregations.Aggregation_Hierarchy StoreObject, Custom_Tracer Tracer ) : void	Stores the item aggregation hierarchy to the cache
Store_Complete_Item_Aggregation ( string Aggregation_Code, Complete_Item_Aggregation StoreObject, Custom_Tracer Tracer ) : void	Stores the copmlete item aggregation object to the cache
Store_Item_Aggregation ( string AggregationCode, Web_Language_Enum Language, Item_Aggregation StoreObject, Custom_Tracer Tracer ) : void	Stores the item aggregation object to the cache

Method Details

CachedDataManager_AggregationServices() public méthode

Constructor for a new instance of the CachedDataManager_AggregationServices class.

public CachedDataManager_AggregationServices ( SobekCM.Core.MemoryMgmt.CachedDataManager_Settings Settings ) : System
Settings	SobekCM.Core.MemoryMgmt.CachedDataManager_Settings	Cached data manager settings object
Résultat	System

Clear() public méthode

Clears all aggregation values from the cache

public Clear ( ) : void
Résultat	void

Clear_Aggregation_Hierarchy() public méthode

Clear the aggregation hierarchy object from the cache

public Clear_Aggregation_Hierarchy ( ) : void
Résultat	void

Remove_Item_Aggregation() public méthode

Removes all references to a particular item aggregation from the cache

public Remove_Item_Aggregation ( string Aggregation_Code, Custom_Tracer Tracer ) : void
Aggregation_Code	string	Code for the item aggregation to remove
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	void

Retrieve_Aggregation_HTML_Based_Content() public méthode

Retrieve the aggregation-level static HTML browse object, including the text itself, from the cache

public Retrieve_Aggregation_HTML_Based_Content ( string Aggregation_Code, Web_Language_Enum Language, string ChildPageCode, Custom_Tracer Tracer ) : HTML_Based_Content
Aggregation_Code	string	Aggregation code
Language	Web_Language_Enum	Requested language version
ChildPageCode	string	Code for the child page in question
Tracer	SobekCM.Tools.Custom_Tracer	The tracer.
Résultat	SobekCM.Core.WebContent.HTML_Based_Content

Retrieve_Aggregation_Hierarchy() public méthode

Retrieves the item aggregation hierarchy from the cache

public Retrieve_Aggregation_Hierarchy ( Custom_Tracer Tracer ) : SobekCM.Core.Aggregations.Aggregation_Hierarchy
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	SobekCM.Core.Aggregations.Aggregation_Hierarchy

Retrieve_Complete_Item_Aggregation() public méthode

Retrieves the complete item aggregation obejct from the cache

public Retrieve_Complete_Item_Aggregation ( string Aggregation_Code, Custom_Tracer Tracer ) : Complete_Item_Aggregation
Aggregation_Code	string	Code for the item aggregation to retrieve
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	SobekCM.Core.Aggregations.Complete_Item_Aggregation

Retrieve_Item_Aggregation() public méthode

Retrieves the item aggregation obejct from the cache

public Retrieve_Item_Aggregation ( string AggregationCode, Web_Language_Enum Language, Custom_Tracer Tracer ) : Item_Aggregation
AggregationCode	string	Code for the item aggregation to retrieve
Language	Web_Language_Enum	Current language code (item aggregation instances are currently language-specific)
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	SobekCM.Core.Aggregations.Item_Aggregation

Store_Aggregation_HTML_Based_Content() public méthode

Store_s the content of the aggregation_ HTM l_ based_.

public Store_Aggregation_HTML_Based_Content ( string Aggregation_Code, Web_Language_Enum Language, string ChildPageCode, HTML_Based_Content StoreObject, Custom_Tracer Tracer ) : void
Aggregation_Code	string	The aggregation_ code.
Language	Web_Language_Enum	The language.
ChildPageCode	string	The child page code.
StoreObject	SobekCM.Core.WebContent.HTML_Based_Content	The store object.
Tracer	SobekCM.Tools.Custom_Tracer	The tracer.
Résultat	void

Store_Aggregation_Hierarchy() public méthode

Stores the item aggregation hierarchy to the cache

public Store_Aggregation_Hierarchy ( SobekCM.Core.Aggregations.Aggregation_Hierarchy StoreObject, Custom_Tracer Tracer ) : void
StoreObject	SobekCM.Core.Aggregations.Aggregation_Hierarchy	Item aggregation object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	void

Store_Complete_Item_Aggregation() public méthode

Stores the copmlete item aggregation object to the cache

public Store_Complete_Item_Aggregation ( string Aggregation_Code, Complete_Item_Aggregation StoreObject, Custom_Tracer Tracer ) : void
Aggregation_Code	string	Code for the item aggregation to store
StoreObject	SobekCM.Core.Aggregations.Complete_Item_Aggregation	Item aggregation object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	void

Store_Item_Aggregation() public méthode

Stores the item aggregation object to the cache

public Store_Item_Aggregation ( string AggregationCode, Web_Language_Enum Language, Item_Aggregation StoreObject, Custom_Tracer Tracer ) : void
AggregationCode	string	Code for the item aggregation to store
Language	Web_Language_Enum	Current language code (item aggregation instances are currently language-specific)
StoreObject	SobekCM.Core.Aggregations.Item_Aggregation	Item aggregation object to store for later retrieval
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
Résultat	void