All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIObjectEvent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIObjectEvent
Usage: you can freely reimplement this interface.
interface ENOVIObjectEvent
Class to be implemented by a client who wants to subscribe to events any VPMObject can raise.
CallBack Interface : when the publisher raises an event, the subscriber is called back on methods
of this interface.
Role: the Subscriber gives a pointer on the implementation of this interface for subscription.
Method Index
- o
onAfterChangeStatus(ENOVIEvent_var&,HRESULT&)
- Method called after the status of a VPMObject was changed .
- o
onAfterCreateObject(ENOVIEvent_var&,HRESULT&)
- Method called after the creation of a VPM object.
- o
onAfterDeleteObject(ENOVIEvent_var&,HRESULT&)
- Method called after the deletion of any VPM object was performed.
- o
onAfterModifyAttribut(ENOVIEvent_var&,HRESULT&)
- Method called after an attribute of a VPMObject was modified.
- o
onAfterSetLock(ENOVIEvent_var&,HRESULT&)
- Method called after a lock was put on a VPM object.
- o
onAfterUnsetLock(ENOVIEvent_var&,HRESULT&)
- Method called after the unlock of any VPM object.
- o
onBeforeChangeStatus(ENOVIEvent_var&,HRESULT&)
- Method called before the status of a VPMObject is changed .
- o
onBeforeCreateObject(ENOVIEvent_var&,HRESULT&)
- Method called before the creation of a VPM object.
- o
onBeforeDeleteObject(ENOVIEvent_var&,HRESULT&)
- Method called before the deletion of any VPM object.
- o
onBeforeModifyAttribut(ENOVIEvent_var&,HRESULT&)
- Method called before an attribute of a VPMObject is modified.
- o
onBeforeSetLock(ENOVIEvent_var&,HRESULT&)
- Method called before the lock of any VPM object.
- o
onBeforeUnsetLock(ENOVIEvent_var&,HRESULT&)
- Method called before the unlock of any VPM object.
- o
onKo(ENOVIEvent_var&,HRESULT&)
- CallBack method when something was wrong for another subscriber.
Methods
o onAfterChangeStatus
public virtual HRESULT onAfterChangeStatus( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the status of a VPMObject was changed .
Role: to call back clients which subscribed to event ChangeStatus - step after -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onAfterCreateObject
public virtual HRESULT onAfterCreateObject( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the creation of a VPM object.
Role: to call back clients which subscribed to CreateObject - step after -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onAfterDeleteObject
public virtual HRESULT onAfterDeleteObject( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the deletion of any VPM object was performed.
Role: to call back clients which subscribed to event DeleteObject - step after -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onAfterModifyAttribut
public virtual HRESULT onAfterModifyAttribut( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after an attribute of a VPMObject was modified.
Role: to call back clients which subscribed to event ModifyAttribute - step after -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onAfterSetLock
public virtual HRESULT onAfterSetLock( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after a lock was put on a VPM object.
Role: to call back clients which subscribed to event SetLock - step after -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onAfterUnsetLock
public virtual HRESULT onAfterUnsetLock( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the unlock of any VPM object.
Role: to call back clients which subscribed to event unsetLock - step after -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeChangeStatus
public virtual HRESULT onBeforeChangeStatus( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the status of a VPMObject is changed .
Role: to call back clients which subscribed to event ChangeStatus - step before -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeCreateObject
public virtual HRESULT onBeforeCreateObject( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the creation of a VPM object.
Role: to call back clients which subscribed to CreateObject - step before -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeDeleteObject
public virtual HRESULT onBeforeDeleteObject( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the deletion of any VPM object.
Role: to call back clients which subscribed to event DeleteObject - step before -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeModifyAttribut
public virtual HRESULT onBeforeModifyAttribut( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before an attribute of a VPMObject is modified.
Role: to call back clients which subscribed to event ModifyAttribute - step before -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeSetLock
public virtual HRESULT onBeforeSetLock( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the lock of any VPM object.
Role: to call back clients which subscribed to event SetLock - step before -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeUnsetLock
public virtual HRESULT onBeforeUnsetLock( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the unlock of any VPM object.
Role: to call back clients which subscribed to event unsetLock - step before -
on any VPM Object Type .
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onKo
public virtual HRESULT onKo( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
CallBack method when something was wrong for another subscriber.
Role: this method is called by the event manager
when a next subscriber returns a failure code from it's callback method.
In that case, all the previous subscribers are called on their onKo() method.
- Parameters:
-
- iEvent
- the instance of event which is currently raised
- ioNotifyReturnCode
- the status of the onKo callback action
This object is included in the file: ENOVIObjectEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces