class MAGES::ListSchema¶

Overview¶

Schema for the List data. More…

class ListSchema: public MAGES::ISchema
{
public:
    // methods

    static ISchema GetInstance();
    void DeleteAllData(string keyPattern);
    void ClearAllData();
    List> GetSpecificData(string keyPattern);
    void DeleteSpecificData(string keyPattern);
    void DeleteData(string key);
    object Get(string key);
    Dictionary GetAllData(string keyPattern);
    void Store(string key, object data);
};

Inherited Members¶

public:
    // methods

    void Store(string key, object data);
    object Get(string key);
    Dictionary GetAllData(string keyPattern);
    void DeleteData(string key);
    void DeleteAllData(string keyPattern);
    List> GetSpecificData(string keyPattern);
    void DeleteSpecificData(string keyPattern);
    void ClearAllData();
    static ISchema GetInstance();

Detailed Documentation¶

Schema for the List data.

Methods¶

static ISchema GetInstance()

Gets the instance of the singleton.

Returns:

The singleton instance.

void DeleteAllData(string keyPattern)

Deletes all data from the schema.

Parameters:

keyPattern	The given schema key.

void ClearAllData()

Clears all data.

List> GetSpecificData(string keyPattern)

Get specific sub-convention/pattern data under the given key pattern.

Parameters:

keyPattern	Given key pattern.

Returns:

Dictionary of data.

void DeleteSpecificData(string keyPattern)

Delete specific sub-convention/pattern data under the given key pattern.

Parameters:

keyPattern	Given key pattern.

void DeleteData(string key)

Deletes data from the schema under the given key.

Parameters:

key	Given key.
ArgumentException	Exception if key wasn’t found.

object Get(string key)

Retrieves data from the schema under the given key.

Parameters:

key	Given key.
ArgumentException	Exception if key wasn’t found.

Returns:

Returns the data under the given key.

Dictionary GetAllData(string keyPattern)

Gets all data from the schema.

Parameters:

keyPattern	Given schema key.

Returns:

Dictionary of data.

void Store(string key, object data)

Stores data in the schema under the given key.

Parameters:

key	Given key.
data	Given data.