All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIChangeOwnerEvent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIChangeOwnerEvent
Usage: you can freely reimplement this interface.
interface ENOVIChangeOwnerEvent
Class to be implemented by a client who wants to subscribe to event ChangeOwner that 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
onAfterChangeOwner(ENOVIEvent_var&,HRESULT&)
- Method called after the owner of a VPMObject was changed .
- o
onBeforeChangeOwner(ENOVIEvent_var&,HRESULT&)
- Method called before the owner of a VPMObject is changed .
- o
onKo(ENOVIEvent_var&,HRESULT&)
- CallBack method when something was wrong for another subscriber.
Methods
o onAfterChangeOwner
public virtual HRESULT onAfterChangeOwner( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the owner of a VPMObject was changed .
Role: to call back clients which subscribed to event ChangeOwner - 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 onBeforeChangeOwner
public virtual HRESULT onBeforeChangeOwner( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the owner of a VPMObject is changed .
Role: to call back clients which subscribed to event ChangeOwner - 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: ENOVIChangeOwnerEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces