CDatabaseObserver Class Reference

#include <CDatabaseObserver.h>

Inheritance diagram for CDatabaseObserver:

Public Member Functions
virtual void	SetDirty (IDataBase *db, UID id, ClassID clsID, ImplementationID tag, const bool16 dbModified)
virtual void	NewUID (IDataBase *db, UID id, ClassID clsID)
virtual void	DeleteUID (IDataBase *db, UID id, ClassID clsID)
virtual void	UndeleteUID (IDataBase *db, UID id, ClassID clsID)
virtual void	DestroyDeletedUID (IDataBase *db, UID id)
virtual void	BeginTransaction (IDataBase *db)
virtual void	EndTransaction (IDataBase *db)
virtual void	SetModified (IDataBase *db, bool16 modified)
virtual void	AttachedTo (IDataBase *db)
Public Member Functions inherited from IDatabaseObserver
virtual uint32	GetEventClassesToObserve ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Additional Inherited Members
Public Types inherited from IDatabaseObserver
enum	Observable {   kWatchDirties = 1, kWatchUIDCreationDestruction = 2, kWatchTransactions = 4, kWatchModified = 8,   kWatchAll = 0xffffffff }

Detailed Description

To find out when certain database actions happen, implement an DatabaseObserver and attach it to the database. Database observers should inherit from CDatabaseObserver and not IDatabaseObserver. See IDatabaseObserver for full details.

See Also

IDataBaseObserver

Member Function Documentation

virtual void CDatabaseObserver::AttachedTo ( IDataBase *  db )

virtual

Called by the database when the observer is attached.

Parameters

db	the database we're observing

Implements IDatabaseObserver.

virtual void CDatabaseObserver::BeginTransaction ( IDataBase *  db )

virtual

Called by the database when it gets an BeginTransaction.

Parameters

db	the database we're observing

Implements IDatabaseObserver.

virtual void CDatabaseObserver::DeleteUID ( IDataBase *  db, UID  id, ClassID  clsID  )

virtual

Called by the database when it gets a DeleteUID.

Parameters

db	the database we're observing
id	the UID that was deleted
clsID	the class of the deleted UID

Implements IDatabaseObserver.

virtual void CDatabaseObserver::DestroyDeletedUID ( IDataBase *  db, UID  id  )

virtual

Called by the database when it gets an DestroyDeletedUID.

Parameters

db	the database we're observing
id	the UID that was destroyed

Implements IDatabaseObserver.

virtual void CDatabaseObserver::EndTransaction ( IDataBase *  db )

virtual

Called by the database when it gets an EndTransaction.

Parameters

db	the database we're observing

Implements IDatabaseObserver.

virtual void CDatabaseObserver::NewUID ( IDataBase *  db, UID  id, ClassID  clsID  )

virtual

Called by the database when it gets a NewUID.

Parameters

db	the database we're observing
id	the UID that was created
clsID	the class of the new UID

Implements IDatabaseObserver.

virtual void CDatabaseObserver::SetDirty ( IDataBase *  db, UID  id, ClassID  clsID, ImplementationID  tag, const bool16  dbModified  )

virtual

Called by the database when it gets a DirtyObject.

Parameters

db	the database we're observing
id	the UID that was dirtied
tag	the ImplementationID that was dirtied
dbModified	kTrue if this dirty could have caused the database to be marked as modified

Implements IDatabaseObserver.

virtual void CDatabaseObserver::SetModified ( IDataBase *  db, bool16  modified  )

virtual

Called by the database when the logical modified state of the database changes.

Parameters

db	the database we're observing
modified	is whether the database mofified state is set (e.g. file is dirty from the user's standpoint)

Implements IDatabaseObserver.

virtual void CDatabaseObserver::UndeleteUID ( IDataBase *  db, UID  id, ClassID  clsID  )

virtual

Called by the database when it gets an UndeleteUID.

Parameters

db	the database we're observing
id	the UID that was restored
clsID	the class of that the UID was restored to

Implements IDatabaseObserver.