KockpitModule Class Reference

Backend interface. More...

#include <kockpitmodule.h>

Inheritance diagram for KockpitModule:
Inheritance graph
[legend]

Public Member Functions

virtual ~KockpitModule ()
 Destructor.
virtual void build (QList< KockpitUnitMap * > *kuml, const KockpitBaseObj &baseobj)=0
 Build kockpit units.
virtual void createEntry (KockpitUnitMap *kunit)=0
 Create backend entry.
virtual void deleteEntry (KockpitUnitMap *kunit)=0
 Delete backend entry.
virtual void modifyEntry (KockpitUnitMap *kunit)=0
 Modify backend entry.
virtual void connect (const KockpitAuthObj &authobj)=0
 Establish backend conection.
virtual void disconnect ()=0
 Destroy existing connection.

Detailed Description

Backend interface.

This interface has to be implemented by a kockpit backend.


Constructor & Destructor Documentation

virtual KockpitModule::~KockpitModule (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual void KockpitModule::build ( QList< KockpitUnitMap * > *  kuml,
const KockpitBaseObj baseobj 
) [pure virtual]

Build kockpit units.

In dependency of the type which is specified in the basobj structure objects will be created and filled with the datasource attribute values.

Parameters:
kuml pointer to List of pointers to KockpitUnitMap objects (could be KockpitUser or KockpitGroup objects.
baseobj This structure specifies the type of the object which should be filled with attribute values.

Implemented in DBModule, and LDAPModule.

virtual void KockpitModule::connect ( const KockpitAuthObj authobj  )  [pure virtual]

Establish backend conection.

With this function a connection to the backend specified with authobj is esablished.

Parameters:
authobj This structure specfifies the connection parameters.

Implemented in DBModule, and LDAPModule.

virtual void KockpitModule::createEntry ( KockpitUnitMap kunit  )  [pure virtual]

Create backend entry.

This function creates an entry in the backend. The backend attributes are determined by the AttributeMaps.

Parameters:
kunit Pointer to KockpitUnitMap.

Implemented in DBModule, and LDAPModule.

virtual void KockpitModule::deleteEntry ( KockpitUnitMap kunit  )  [pure virtual]

Delete backend entry.

This function deletes an entry from the backend. The backend attributes are determined by the AttributeMaps.

Parameters:
kunit Pointer to KockpitUnitMap.

Implemented in DBModule, and LDAPModule.

virtual void KockpitModule::disconnect (  )  [pure virtual]

Destroy existing connection.

Implemented in DBModule, and LDAPModule.

virtual void KockpitModule::modifyEntry ( KockpitUnitMap kunit  )  [pure virtual]

Modify backend entry.

This function modifies an entry in the backend. The backend attributes are determined by the AttributeMaps.

Parameters:
kunit Pointer to KockpitUnitMap.

Implemented in DBModule, and LDAPModule.


The documentation for this class was generated from the following file:
Generated on Wed Mar 24 09:58:14 2010 for kockpit by  doxygen 1.6.3