IlsViewedRel Class Reference

This class is the parent class for all classes that declare relations. More...

#include <ilserver/viewed.h>

Inheritance diagram for IlsViewedRel:

Public Member Functions
virtual IlsViewed *	getIdentifiedElement (const IlsString &id) const
	This virtual member function is used to retrieve an identified object from the relation. More...
virtual IlsBoolean	hasElement (IlsViewed &) const
	This virtual member function returns IlsTrue if the element is a target of the relation or IlsFalse otherwise.
IlsBoolean	isViewed ()
	This member function returns IlsTrue if at least one regular view (as opposed to a multithreaded view) subscribes to the relation. More...
virtual void	onSubscribe (IlsView &)
	This empty virtual member function is called each time a view subscribes to the relation.
virtual void	onUnsubscribe (IlsView &)
	This empty virtual member function is called each time the subscription of a view to the relation is canceled.

Protected Member Functions
	IlsViewedRel ()
	This is the protected constructor of the class.

Detailed Description

This class is the parent class for all classes that declare relations.

Library: server

It is used as an argument in some member functions of the class IlsMvView.

See also

IlsMvView, IlsOwns, IlsOwnsDynamicArray, IlsOwnsFixedArray, IlsOwnsList, IlsUses, IlsUsesDynamicArray, IlsUsesFixedArray, IlsUsesList.

Member Function Documentation

getIdentifiedElement()

virtual IlsViewed* IlsViewedRel::getIdentifiedElement ( const IlsString &  id ) const

virtual

This virtual member function is used to retrieve an identified object from the relation.

The member function IlsViewed::getKeyIdentifier() is used to retrieve the identifier of the relation element.

Note

On all subclasses of this class, the complexity of this method is always linear, in terms of the number of elements in the relation, even for set relations.

Reimplemented in IlsUsesSet< UserType, UsedType, KeyType, KeyManager >, IlsUsesSet< IlsDynObject, IlsUsed, IlsString, ObjectKeyManager >, IlsOwnsSet< OwnerType, OwnedType, KeyType, KeyManager >, IlsOwnsSet< IlsDynObject, IlsObject, IlsString, ObjectKeyManager >, IlsUsesDynamicArray< UserType, UsedType >, IlsOwnsDynamicArray< OwnerType, OwnedType >, IlsUsesFixedArray< UserType, UsedType, size >, IlsOwnsFixedArray< OwnerType, OwnedType, size >, IlsInvertedRelationList< TargetType, OriginType >, IlsInvertedRelationList< IlsDynObject, IlsUsed >, IlsUsesList< UserType, UsedType >, IlsUsesList< IlsDynObject, IlsUsed >, IlsOwnsList< OwnerType, OwnedType >, and IlsOwnsList< IlsDynObject, IlsObject >.

isViewed()

IlsBoolean IlsViewedRel::isViewed

(

)

This member function returns IlsTrue if at least one regular view (as opposed to a multithreaded view) subscribes to the relation.

This function is supplied to maintain upward compatibility. For efficiency reasons, multithreaded views do not update this information. However, you can have it updated by overriding the virtual member functions onSubscribe() and onUnsubscribe().