iweStorage Interface Reference

Interface for storage subsystem. More...

#include <weiStorage.h>

Inheritance diagram for iweStorage:

List of all members.

Public Types
enum	Operation { mask = 0xff }
Public Member Functions
	iweStorage (void *handle=NULL)
virtual	~iweStorage (void)
virtual void *	GetInterface (const string &ifName)
	Gets an interface.
virtual char **	GetIcon ()
	Gets the icon.
virtual const string	InterfaceName ()
	Gets the final Interface name.
virtual WeStringList	InterfaceList ()
	Gets the list of supported Interfaces.
virtual string	GenerateID (string objType="")
virtual int	Query (const string &objType, Operation op, const string &xmlData)
virtual int	Report (const string &repType, const string &xmlData, string &result)
virtual int	Delete (const string &objType, const string &xmlData)
virtual int	TaskSave (const string &xmlData, Operation op=iweStorage::autoop)
virtual int	DictionarySave (const string &xmlData, Operation op=iweStorage::autoop)
virtual int	AuthorizationSave (const string &xmlData, Operation op=iweStorage::autoop)
virtual int	SystemOptionsSave (const string &xmlData, Operation op=iweStorage::autoop)
virtual int	TaskReport (const string &xmlData, string &result)
virtual int	DictionaryReport (const string &xmlData, string &result)
virtual int	AuthorizationReport (const string &xmlData, string &result)
virtual int	SystemOptionsReport (const string &xmlData, string &result)
Static Public Attributes
static const Operation	insert = (Operation)0x01
static const Operation	update = (Operation)0x02
static const Operation	remove = (Operation)0x03
static const Operation	autoop = (Operation)0xff
Static Protected Attributes
static int	lastId = 0

---

Detailed Description

Interface for storage subsystem.

Author:

A. Abramov, A. Yudin

Date:

14.07.2009

Definition at line 34 of file weiStorage.h.

---

Member Enumeration Documentation

enum iweStorage::Operation

Enumerator:

mask

Definition at line 48 of file weiStorage.h.

---

Constructor & Destructor Documentation

iweStorage::iweStorage

(

void *

handle = NULL

)

Definition at line 82 of file weiStorage.cpp.

iweStorage::~iweStorage

(

void

)

[virtual]

Definition at line 87 of file weiStorage.cpp.

---

Member Function Documentation

int iweStorage::AuthorizationReport	(	const string &	xmlData,
		string &	result
	)			[virtual]

Todo:

postprocess result

Definition at line 183 of file weiStorage.cpp.

int iweStorage::AuthorizationSave	(	const string &	xmlData,
		Operation	op = iweStorage::autoop
	)			[virtual]

Todo:

Add input data validation

Definition at line 157 of file weiStorage.cpp.

int iweStorage::Delete	(	const string &	objType,
		const string &	xmlData
	)			[virtual]

Implemented in WeMemStorage.

Definition at line 140 of file weiStorage.cpp.

int iweStorage::DictionaryReport	(	const string &	xmlData,
		string &	result
	)			[virtual]

Todo:

postprocess result

Definition at line 176 of file weiStorage.cpp.

int iweStorage::DictionarySave	(	const string &	xmlData,
		Operation	op = iweStorage::autoop
	)			[virtual]

Todo:

Add input data validation

Definition at line 151 of file weiStorage.cpp.

std::string iweStorage::GenerateID

(

string

objType = ""

)

[virtual]

Definition at line 121 of file weiStorage.cpp.

char ** iweStorage::GetIcon

(

)

[virtual]

Gets the icon.

Returns pointer to the array of chars, that represents image in the XPM format. This image may be used to identify the plugin in GUI.

Return values:

null

if no icon, else the icon.

Implements iwePlugin.

Definition at line 104 of file weiStorage.cpp.

void * iweStorage::GetInterface

(

const string &

ifName

)

[virtual]

Gets an interface.

Returns abstracted pointer to the requested interface, or NULL if the requested interface isn't provided by this object. The interface name depends on the plugin implementation.

Parameters:

ifName

- Name of the interface.

Return values:

null

if it fails, else the interface.

Implements iwePlugin.

Implemented in WeMemStorage.

Definition at line 91 of file weiStorage.cpp.

WeStringList iweStorage::InterfaceList

(

)

[virtual]

Gets the list of supported Interfaces.

Return values:

strings

list.

Implements iwePlugin.

Implemented in WeMemStorage.

Definition at line 114 of file weiStorage.cpp.

const string iweStorage::InterfaceName

(

)

[virtual]

Gets the final Interface name.

Return values:

string.

Implements iwePlugin.

Implemented in WeMemStorage.

Definition at line 109 of file weiStorage.cpp.

int iweStorage::Query	(	const string &	objType,
		Operation	op,
		const string &	xmlData
	)			[virtual]

Todo:

Implement this!

Implemented in WeMemStorage.

Definition at line 126 of file weiStorage.cpp.

int iweStorage::Report	(	const string &	repType,
		const string &	xmlData,
		string &	result
	)			[virtual]

Todo:

Implement this!

Implemented in WeMemStorage.

Definition at line 133 of file weiStorage.cpp.

int iweStorage::SystemOptionsReport	(	const string &	xmlData,
		string &	result
	)			[virtual]

Todo:

postprocess result

Definition at line 190 of file weiStorage.cpp.

int iweStorage::SystemOptionsSave	(	const string &	xmlData,
		Operation	op = iweStorage::autoop
	)			[virtual]

Todo:

Add input data validation

Definition at line 163 of file weiStorage.cpp.

int iweStorage::TaskReport	(	const string &	xmlData,
		string &	result
	)			[virtual]

Todo:

postprocess result

Definition at line 169 of file weiStorage.cpp.

int iweStorage::TaskSave	(	const string &	xmlData,
		Operation	op = iweStorage::autoop
	)			[virtual]

Todo:

Add input data validation

Definition at line 145 of file weiStorage.cpp.

---

Member Data Documentation

const Operation iweStorage::autoop = (Operation)0xff [static]

Definition at line 52 of file weiStorage.h.

const Operation iweStorage::insert = (Operation)0x01 [static]

Definition at line 49 of file weiStorage.h.

int iweStorage::lastId = 0 [static, protected]

Definition at line 72 of file weiStorage.h.

const Operation iweStorage::remove = (Operation)0x03 [static]

Definition at line 51 of file weiStorage.h.

const Operation iweStorage::update = (Operation)0x02 [static]

Definition at line 50 of file weiStorage.h.

---

The documentation for this interface was generated from the following files:

• weiStorage.h
• weiStorage.cpp