All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIEvent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIEvent
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIEvent
Interface to manipulate instances of event raised by ENOVIA objects.
Role: an ENOVIEvent carries information about the raised event between Publisher and subscribers.
name of event.
publisher identity ENOVIPublisher
date of raise
associated data from publisher
ENOVIStream.
a client or subscriber can also fill put information in the ENOVIEvent.
This interface is implemented and ready to be used.
- See also:
- ENOVIStream, ENOVIPublisher
Method Index
- o
GetClientData(ENOVIStream_var&)
- Gets the client Data stream.
- o
GetCookieSession(CATUnicodeString&)
- gives the cookie (identity) of the Session in which is event is raised.
- o
GetCurrentStep(VPMEventFireMode&)
- Get the current step of the event.
- o
GetDataEvent(ENOVIStream_var&)
- Get Input Data Stream associated with the current emitted event.
- o
GetName(CATUnicodeString&)
- Name of the instance of event.
- o
GetPublishDate(CATTime&)
- Get the most recent date when the event was raised.
- o
GetPublishDate(CORBAAny&)
- Get the most recent date when the event was raised.
- o
GetPublisher(ENOVIPublisher_var&)
- Get the publisher Id which raised event.
- o
GetSourceObject(CATBaseUnknown_var&)
- gives the real object for which the event is raised.
- o
SetClientData(ENOVIStream_var&)
- Sets the client data stream in the event.
Enumerated Type Index
- o
VPMEventFireMode
- Enumeration to precise the steps in raising an event.
Methods
o GetClientData
public virtual HRESULT GetClientData( | ENOVIStream_var& | oAssociatedStream) = 0 |
-
Gets the client Data stream.
Role: Streams in an event.
- EventData is given by the publisher to transmit information to Subscribers
- ClientData is filled by the subscribers to give back Publisher information
NB : The client data have a format defined by the Publisher, in order to be able to read it.
If many clients want to store information, this information is added sequentially at the
end of the stream.
- Parameters:
-
- oAssociatedStream
- the client stream.
- See also:
- ENOVIStream
o GetCookieSession
-
gives the cookie (identity) of the Session in which is event is raised.
- Parameters:
-
- oCookie
- a string giving the identity of the current session.
o GetCurrentStep
public virtual HRESULT GetCurrentStep( | VPMEventFireMode& | oCurrentStep)=0 |
-
Get the current step of the event.
- Parameters:
-
- oCurrentStep
- the current step of the event life : Before/After or Standard.
o GetDataEvent
public virtual HRESULT GetDataEvent( | ENOVIStream_var& | oDataEvent)=0 |
-
Get Input Data Stream associated with the current emitted event.
Role: Streams in an event.
- EventData is given by the publisher to transmit information to Subscribers
- ClientData is filled by the subscribers to give back Publisher information
NB : The ClientData has a format defined by the Publisher, in order to be able to read it.
- Parameters:
-
- oDataEvent
- the associated stream.
- See also:
- ENOVIStream
o GetName
-
Name of the instance of event.
- Parameters:
-
- oEventName
- the name of Event (ex: Lock, Create, Delete, ChangeStatus ...)
o GetPublishDate
-
Get the most recent date when the event was raised.
- Parameters:
-
- oPublishDate
- the publish date under a classical format
o GetPublishDate
-
Get the most recent date when the event was raised.
- Parameters:
-
- oPDate
- the publish date under a CORBAAny Format
o GetPublisher
public virtual HRESULT GetPublisher( | ENOVIPublisher_var& | oPublisher)=0 |
-
Get the publisher Id which raised event.
- Parameters:
-
- oPublisher
- the Object which raises the event.
- See also:
- ENOVIPublisher
o GetSourceObject
-
gives the real object for which the event is raised.
Role: A publisher can raise an event for another object. In that
case, the object for which the event was raised is given here.
In normal cases, GetPublisher and GetSourceObject give the same result.
May be used only in the creation case.
- Parameters:
-
- oSource
- the object for which the event is raised.
o SetClientData
public virtual HRESULT SetClientData( | const ENOVIStream_var& | iAssociatedStream)= 0 |
-
Sets the client data stream in the event.
Role: Streams in an event.
- EventData is given by the publisher to transmit information to Subscribers
- ClientData is filled by the subscribers to give back Publisher information
NB : The client data have a format defined by the Publisher, in order to be able to read it.
If many clients want to store information, this information is added sequentially at the
end of the stream.
- Parameters:
-
- iAssociatedStream
- the stream filled by the client.
- See also:
- ENOVIStream
Enumerated Types
o VPMEventFireMode
-
enum VPMEventFireMode {
EventFireBefore,
EventFireAfter,
EventFireStandard
}
Enumeration to precise the steps in raising an event.
Role: an Event can be raised in 2 steps( Before at the beginning of the method,
After at the end of the method), or in one single step (standard). The first way may be
used generally.
This object is included in the file: ENOVIEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces