class MAGES::StubDataContainer¶

Overview¶

Stub class for the data container module. More…

class StubDataContainer: public MAGES::DataContainerModule
{
public:
    // methods

    override void Startup();
    override void Shutdown();
    override void SetSchema(string keyPattern, Type schemaType);
    override void StoreData(string key, object value);
    override object GetData(string key);
    override Dictionary GetSchemaData(string keyPattern);
    override void DeleteData(string key);
    override void DeleteSchema(string keyPattern);
    override List> GetSpecificSchemaData(string keyPattern);
    override void DeleteSpecificSchemaData(string keyPattern);
    override void ClearAllData();
};

Inherited Members¶

public:
    // properties

    int Version;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);
    void SetSchema(string keyPattern, Type schemaType);
    void StoreData(string key, object value);
    object GetData(string key);
    Dictionary GetSchemaData(string keyPattern);
    void DeleteData(string key);
    void DeleteSchema(string keyPattern);
    List> GetSpecificSchemaData(string keyPattern);
    void DeleteSpecificSchemaData(string keyPattern);
    void ClearAllData();

Detailed Documentation¶

Stub class for the data container module.

Methods¶

override void Startup()

Startup data container (stub).

override void Shutdown()

Startup analytics (stub).

override void SetSchema(string keyPattern, Type schemaType)

Sets the schema for the data container.

Parameters:

keyPattern	The convention/pattern the Schema is created under, i.e mages.actions.* .
schemaType	The type of the Schema.

override void StoreData(string key, object value)

Stores data in the schema defined under the given key.

Parameters:

key	The given key.
value	The value to be stored.
ArgumentException	Throws an exception if the key is not found.

override object GetData(string key)

Gets the data stored under the given key.

Parameters:

key	The given key.
ArgumentException	If no data is found under the given key.

Returns:

The value stored under the given key.

override Dictionary GetSchemaData(string keyPattern)

Gets the whole Schema data stored under the given convention/pattern.

Parameters:

keyPattern	The convention/pattern the Schema is defined under.

Returns:

A dictionary of the whole Schema data.

override void DeleteData(string key)

Deletes the data under the given key.

Parameters:

key	Given data key.
ArgumentException	Throws exception if the key is not found.

override void DeleteSchema(string keyPattern)

Deletes the whole Schema under the given key.

Parameters:

keyPattern	The given pattern/convention of the schema.
ArgumentException	Throws an exception if the key is not found.

override void ClearAllData()

Clears all data.