IRIDXNotifierHandler Class Reference

#include <IRIDXNotifierHandler.h>

Inheritance diagram for IRIDXNotifierHandler:

Public Types
enum	{ kDefaultIID = IID_IRIDXNOTIFIERHANDLER }
enum	NotificationType { kBeingDeleted, kWillBeModified, kTestActivelyUsed, kSwatchesWillBeConvertedLocalToGlobal }
enum	NotificationStatus { kHandledStatus, kDidntHandleStatus, kTrueStatus, kFalseStatus }

Public Member Functions
virtual NotificationStatus	Notify (const NotificationType type, IDataBase *db, const UID targetUID, const RIDXSource &source, const IPMUnknown *data) const =0
virtual NotificationStatus	Notify (const NotificationType type, IDataBase *db, const UIDList &targetUIDList, const RIDXSource &source, const IPMUnknown *data) const =0
virtual bool16	WantsNotification (const NotificationType type, const ClassID classIDOfTarget) const =0
virtual bool16	AlwaysNotifyForNonPersistReferences (const NotificationType type, const ClassID classIDOfTarget) const =0
virtual NotificationStatus	Notify (const NotificationType type, IDataBase *db, const UIDList &targetUIDList, const IPMUnknown *data) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Handler which is called when the UID is being modified in some way, deleted, or just to query if it is being actively used. These functions are called by

Member Enumeration Documentation

enum IRIDXNotifierHandler::NotificationStatus

Type of Notification status. Will return if the notification was handled, also if the notification is a bool question (like IsActivelyUses) it will return a boolean result (kTrueStatus or kFalseStatus)

enum IRIDXNotifierHandler::NotificationType

Type of Notification being sent. Currently deleting, modifying, and checking if the UID is actively used

Member Function Documentation

virtual bool16 IRIDXNotifierHandler::AlwaysNotifyForNonPersistReferences ( const NotificationType  type, const ClassID  classIDOfTarget  ) const

pure virtual

AlwaysNotifyForNonPersistReferences: return true if the handler wants to be notified wheneve changes are made to this type of class. The handler wants to return true in this case if there are non-persistent cases which will need notification.

Parameters

type	type of the notification
classIDOfTarget	the classID of the target

virtual NotificationStatus IRIDXNotifierHandler::Notify ( const NotificationType  type, IDataBase *  db, const UID  targetUID, const RIDXSource &  source, const IPMUnknown *  data  ) const

pure virtual

Notify: Nofitication sent when a particular UID is being manipulated

Parameters

type	type of the notification
db	The database it is being deleted from
targetUID	The uid notification is being sent about
source	The information about the source with the link to the UID
data	Any data needed by the Notify

Returns

NotificationStatus The status of the notification, whether it was handled or not or whether it answers the question or not

virtual NotificationStatus IRIDXNotifierHandler::Notify ( const NotificationType  type, IDataBase *  db, const UIDList &  targetUIDList, const RIDXSource &  source, const IPMUnknown *  data  ) const

pure virtual

Notify: Nofitication sent when a list of UID is being manipulated

Parameters

type	type of the notification
db	The database it is being deleted from
targetUIDList	The uid notification is being sent about
source	The information about the source with the link to the list of UIDs
data	Any data needed by the Notify

Returns

NotificationStatus The status of the notification, whether it was handled or not or whether it answers the question or not

Precondition

The UIDs in the targetUIDList must all referenced by the same source (same source UID and implementation).

virtual NotificationStatus IRIDXNotifierHandler::Notify ( const NotificationType  type, IDataBase *  db, const UIDList &  targetUIDList, const IPMUnknown *  data  ) const

pure virtual

Notify: Nofitication sent when a list of UID is being manipulated

Parameters

type	type of the notification
db	The database it is being deleted from
targetUIDList	The uid notification is being sent about
data	Any data needed by the Notify

Returns

NotificationStatus The status of the notification, whether it was handled or not or whether it answers the question or not

virtual bool16 IRIDXNotifierHandler::WantsNotification ( const NotificationType  type, const ClassID  classIDOfTarget  ) const

pure virtual

WantsNotification: returns true if this handler wants to be notified when changes are made to this type of class

Parameters

type	type of the notification
classIDOfTarget	the classID of the target
data	Any data needed by the Notify