cMediatorInterface Class Reference

#include <object.h>

Inheritance diagram for cMediatorInterface:

[legend]

List of all members.

Public Member Functions
virtual cUPnPClassObject *	createObject (const char *Title, bool Restricted)=0
virtual cUPnPClassObject *	getObject (cUPnPObjectID ID)=0
virtual int	saveObject (cUPnPClassObject *Object)=0
virtual int	deleteObject (cUPnPClassObject *Object)=0
virtual int	clearObject (cUPnPClassObject *Object)=0

---

Detailed Description

Mediator interface

This is an interface for mediators used to communicate with the database. A mediator is applied to get, create, save or delete an UPnP object.

---

Member Function Documentation

virtual int cMediatorInterface::clearObject

(

cUPnPClassObject *

Object

)

[pure virtual]

Clears the object

This clears the object, i.e. all its children will be removed and deleted from the database

Returns:

returns

• <0, in case of an error
• 0, otherwise

Parameters:

Object

the object to be cleared

Implemented in cUPnPObjectMediator.

virtual cUPnPClassObject* cMediatorInterface::createObject	(	const char *	Title,
		bool	Restricted
	)			[pure virtual]

Creates an object

This creates a new UPnP object with the specific title and the restriction.

Returns:

the newly created object

Parameters:

	Title	the title of that object
	Restricted	the restriction of the object

Implemented in cUPnPObjectMediator, cUPnPItemMediator, cUPnPVideoItemMediator, cUPnPVideoBroadcastMediator, cUPnPMovieMediator, and cUPnPContainerMediator.

virtual int cMediatorInterface::deleteObject

(

cUPnPClassObject *

Object

)

[pure virtual]

Deletes the object

This deletes the object in the database by removing all its children and then deleting the contents from the database

Returns:

returns

• <0, in case of an error
• 0, otherwise

Parameters:

Object

the object to be deleted

Implemented in cUPnPObjectMediator.

virtual cUPnPClassObject* cMediatorInterface::getObject

(

cUPnPObjectID

ID

)

[pure virtual]

Get an object

Retrieves a UPnP object from the database and stores its information in the object. The object is obtained via its object ID.

Returns:

the object, found in the database

Parameters:

ID

the object ID

Implemented in cUPnPObjectMediator, cUPnPItemMediator, cUPnPVideoItemMediator, cUPnPVideoBroadcastMediator, cUPnPMovieMediator, and cUPnPContainerMediator.

virtual int cMediatorInterface::saveObject

(

cUPnPClassObject *

Object

)

[pure virtual]

Saves the object

This saves the object in the database by updating the values in the database with those in the object.

Returns:

returns

• <0, in case of an error
• 0, otherwise

Parameters:

Object

the object to be saved

Implemented in cUPnPObjectMediator.

---

The documentation for this class was generated from the following file:

• database/object.h