IlsDynRelations Class Reference

This abstract class is the base class for the collection of relations of a dynamic object. More...

#include <ilserver/dynimpl.h>

Inherited by IlsDynRelationArray, and IlsDynRelationMap.

Public Member Functions
	IlsDynRelations (IlsDynObject *holder)
	This constructor receives the holder object for the collection to be built.
virtual void	addRelation (const IlsRelationDef &, IlsDynRelation &)=0
	This virtual member function adds a dynamic relation to the collection. More...
virtual int	getCount () const =0
	This virtual member function returns the number of dynamic relations stored in the collection.
virtual IlsDynRelation *	getDynRelation (const IlsDynObject &holder, const IlsRelationDef &) const =0
	This virtual member function returns a dynamic relation, given its definition and its holder. More...
virtual IlsDynObject *	getHolder () const
	This member function returns the holder of the collection. More...
virtual IlsDynRelation *	newRelation (IlsDynObject &holder, const IlsRelationDef &)
	This virtual member function is called by Server when a new relation must be built. More...
virtual void	rmRelation (const IlsRelationDef &, IlsBoolean del=IlsTrue)=0
	This virtual member function removes a dynamic relation from the collection. More...

Detailed Description

This abstract class is the base class for the collection of relations of a dynamic object.

Library: dynmvsvr

It provides the API used by Rogue Wave Server to create or access dynamic relations. If you choose to subclass this class, the member function IlsDynObjectFactory::newRelations() must create an instance of your subclass.

See also

IlsDynRelation, IlsDynRelationFactory.

Member Function Documentation

addRelation()

virtual void IlsDynRelations::addRelation ( const IlsRelationDef &  , IlsDynRelation &    )

pure virtual

This virtual member function adds a dynamic relation to the collection.

This function should be overriden.

getDynRelation()

virtual IlsDynRelation* IlsDynRelations::getDynRelation ( const IlsDynObject &  holder, const IlsRelationDef &    ) const

pure virtual

This virtual member function returns a dynamic relation, given its definition and its holder.

This function should be overriden.

getHolder()

virtual IlsDynObject* IlsDynRelations::getHolder ( ) const

virtual

This member function returns the holder of the collection.

This function should be overriden.

newRelation()

virtual IlsDynRelation* IlsDynRelations::newRelation ( IlsDynObject &  holder, const IlsRelationDef &    )

virtual

This virtual member function is called by Server when a new relation must be built.

The default implementation invokes the methods of the class IlsDynRelationFactory and calls IlsDynRelationFactory::addRelation().

rmRelation()

virtual void IlsDynRelations::rmRelation ( const IlsRelationDef &  , IlsBoolean  del = IlsTrue  )

pure virtual

This virtual member function removes a dynamic relation from the collection.

If the argument del is IlsTrue, the dynamic relation must be deleted.

This function should be overriden.