All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVISessionEvent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVISessionEvent
Usage: you can reimplement this interface by deriving the supplied ENOVPackageListener adapter class.
interface ENOVISessionEvent
Class to be implemented by a client who wants to subscribe to events that a Session and a LoginSession 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.
Please note that libraries that provide an implementation of this
interface must link with as little dependencies as possible, as this
is loaded at the very beginning of the session.
BOA information: this interface CANNOT be implemented
using the BOA (Basic Object Adapter).
To know more about the BOA, refer to the CAA Encyclopedia home page.
Click Middleware at the bottom left, then click the Object Modeler tab page.
Several articles deal with the BOA.
Method Index
- o
onAfterAbortCommand(ENOVIEvent_var&,HRESULT&)
- Method called after a command was aborted.
- o
onAfterAbortLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called after the Login Session was aborted.
- o
onAfterCloseLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called after the Login Session is closed.
- o
onAfterCreateLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called when the event CreateLoginSession is emitted at step AFTER.
- o
onAfterExecuteCommand(ENOVIEvent_var&,HRESULT&)
- Method called after the command was executed.
- o
onAfterSaveLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called after the Login Session was saved.
- o
onAfterStartCommand(ENOVIEvent_var&,HRESULT&)
- Method called after the command was executed.
- o
onAfterUndoCommand(ENOVIEvent_var&,HRESULT&)
- Method called after the UndoCommand was executed.
- o
onBeforeAbortCommand(ENOVIEvent_var&,HRESULT&)
- Method called before a command is aborted.
- o
onBeforeAbortLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called before the Login Session is aborted.
- o
onBeforeCloseLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called before the Login Session is closed.
- o
onBeforeExecuteCommand(ENOVIEvent_var&,HRESULT&)
- Method called before a command is executed.
- o
onBeforeSaveLoginSession(ENOVIEvent_var&,HRESULT&)
- Method called before the Login Session is saved.
- o
onBeforeStartCommand(ENOVIEvent_var&,HRESULT&)
- Method called before a command starts.
- o
onBeforeUndoCommand(ENOVIEvent_var&,HRESULT&)
- Method called before UndoCommand is done.
- o
onKo(ENOVIEvent_var&,HRESULT&)
- CallBack method when something was wrong for another subscriber.
Methods
o onAfterAbortCommand
public virtual HRESULT onAfterAbortCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after a command was aborted.
Role: used by event model to call back clients which subscribed to event AbortCommand - step after -
on the Login Session .
- 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 onAfterAbortLoginSession
public virtual HRESULT onAfterAbortLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the Login Session was aborted.
Role: used by event model to call back clients which subscribed to event AbortLoginSession - step after -
on the Login Session .
- 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 onAfterCloseLoginSession
public virtual HRESULT onAfterCloseLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the Login Session is closed.
Role: used by event model to call back clients which subscribed to event CloseLoginSession - step after -
on the Login Session .
- 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 onAfterCreateLoginSession
public virtual HRESULT onAfterCreateLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called when the event CreateLoginSession is emitted at step AFTER.
Role: used by event model to call back clients which subscribed to CreateLoginSession - step after -
on the VPMSession . This step occurs after creation of the login session was performed.
Note that up to V5R12 it is forbidden to perform licensed QueryInterface calls or call any licensed
code in your implementation of this method, since license acquisition might not have taken placed yet
at that point. Therefore you must defer such calls till after CATIVpmSCLogin::Login has been completed.
If you need to register a callback for a licensed event interface (such as ENOVIDocEvents), then you
should not do the QueryInterface, and pass ENOVIEventManager::Subscribe a pointer for the callback object
that is not the licensed interface pointer, but another pointer to the same object, then the event manager
code will perform the actual licensed QueryInterface call at event emission time.
It is of course forbidden to call CATIVpmSCLogin::Login in the implementation of this method, as this will
usually perform an automatic security login with the wrong parameters, breaking the whole product.
- 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 onAfterExecuteCommand
public virtual HRESULT onAfterExecuteCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the command was executed.
Role: used by event model to call back clients which subscribed to event ExecuteCommand - step after -
on the Login Session .
- 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 onAfterSaveLoginSession
public virtual HRESULT onAfterSaveLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the Login Session was saved.
Role: used by event model to call back clients which subscribed to event SaveLoginSession - step after -
on the Login Session.
It is forbidden to perform any model modifications or to raise other events in an implementation of this
method. Since it is called right after the transaction has been closed, transactional operations cannot be
invoked (notably, SDAI/VPMObjects model modification will not have any effet until the next commit).
It is strongly recommended that you avoid calling LCA code in your implementation of this method.
- 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 onAfterStartCommand
public virtual HRESULT onAfterStartCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the command was executed.
Role: used by event model to call back clients which subscribed to event StartCommand - step after -
on the Login Session .
- 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 onAfterUndoCommand
public virtual HRESULT onAfterUndoCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after the UndoCommand was executed.
Role: used by event model to call back clients which subscribed to event UndoCommand - step after -
on the Login Session .
- 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 onBeforeAbortCommand
public virtual HRESULT onBeforeAbortCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before a command is aborted.
Role: used by event model to call back clients which subscribed to event AbortCommand - step before -
on the Login Session .
- 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 onBeforeAbortLoginSession
public virtual HRESULT onBeforeAbortLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the Login Session is aborted.
Role: used by event model to call back clients which subscribed to event AbortLoginSession - step before -
on the Login Session .
- 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 onBeforeCloseLoginSession
public virtual HRESULT onBeforeCloseLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the Login Session is closed.
Role: used by event model to call back clients which subscribed to event CloseLoginSession - step before -
on the Login Session .
- 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
E_ACESSDENIED if a veto is put on the close
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeExecuteCommand
public virtual HRESULT onBeforeExecuteCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before a command is executed.
Role: used by event model to call back clients which subscribed to event ExecuteCommand - step before -
on the Login Session .
- 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 onBeforeSaveLoginSession
public virtual HRESULT onBeforeSaveLoginSession( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before the Login Session is saved.
Role: used by event model to call back clients which subscribed to event SaveLoginSession - step before -
on the Login Session .
- 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
E_ACESSDENIED if a veto is put on the save
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeStartCommand
public virtual HRESULT onBeforeStartCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before a command starts.
Role: used by event model to call back clients which subscribed to event StartCommand - step before -
on the Login Session .
- 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 onBeforeUndoCommand
public virtual HRESULT onBeforeUndoCommand( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before UndoCommand is done.
Role: used by event model to call back clients which subscribed to event UndoCommand - step before -
on the Login Session .
- 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: ENOVISessionEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces