All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIAttachGCoEvent

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---ENOVIAttachGCoEvent
 

Usage: you can freely reimplement this interface.


interface ENOVIAttachGCoEvent

Class to be implemented by a client who wants to subscribe to events AttachOnGCo/DetachFromGCo which may be raised .
CallBack Interface : when the publisher raises an event AttachOnGCo/DetachFromGCo, 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 onAfterAttachOnGCo(ENOVIEvent_var&,HRESULT&)
Method called after an add generic component link action was done.
o onAfterDetachFromGCo(ENOVIEvent_var&,HRESULT&)
Method called after a remove generic component link action was done.
o onBeforeAttachOnGCo(ENOVIEvent_var&,HRESULT&)
Method called before an add generic component link action is done .
o onBeforeDetachFromGCo(ENOVIEvent_var&,HRESULT&)
Method called before a remove generic component link action is done .
o onKo(ENOVIEvent_var&,HRESULT&)
CallBack method when something was wrong for another subscriber.

Methods


o onAfterAttachOnGCo
public virtual HRESULT onAfterAttachOnGCo( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called after an add generic component link action was done.
Role: to call back clients which subscribed to AttachOnGCo event -step after -
Parameters:
iRaisedEvent
the instance of event which is currently raised. It is the current GCo.
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 onAfterDetachFromGCo
public virtual HRESULT onAfterDetachFromGCo( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called after a remove generic component link action was done.
Role: to call back clients which subscribed to DetachFromGCo event -step after -
Parameters:
iRaisedEvent
the instance of event which is currently raised. It is the current GCo.
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 onBeforeAttachOnGCo
public virtual HRESULT onBeforeAttachOnGCo( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called before an add generic component link action is done .
Role: to call back clients which subscribed to AttachOnGCo event - step before -
Parameters:
iRaisedEvent
the instance of event which is currently raised. It is the current GCo.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
E_ACCESSDENIED if the subscriber wants to put a veto . This code will be taken into account only if the event on the object type was declared veto able. S_OK if everything was right
See also:
ENOVIEvent
o onBeforeDetachFromGCo
public virtual HRESULT onBeforeDetachFromGCo( const ENOVIEvent_var& iRaisedEvent,
HRESULT& ioNotifyReturnCode) = 0
Method called before a remove generic component link action is done .
Role: to call back clients which subscribed to DetachFromGCo event - step before -
Parameters:
iRaisedEvent
the instance of event which is currently raised. It is the current GCo.
ioNotifyReturnCode
the status to be returned by the method :
E_FAIL if there was a problem
E_ACCESSDENIED if the subscriber wants to put a veto . This code will be taken into account only if the event on the object type was declared veto able. 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
See also:
ENOVIEvent

This object is included in the file: ENOVIAttachGCoEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.