All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface ENOVIEventDefinition

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface ENOVIEventDefinition

Interface to get the definitions of events that a publisher (type or instance) can raise.
Role:
All information about events are stored: the event name, the root type for which this event was registered, the package it belongs to, if there is an associated data stream, what are the associated callback interfaces, etc.


Method Index


o GetAssociatedData(CATUnicodeString&,CATListOfCATUnicodeString&)
Gets the data stream associated to the event.
o GetCallBackInterfaceNames(CATListOfCATUnicodeString&)
Gets the list of callback interfaces associated to the event.
o GetEventName(CATUnicodeString&)
Gets the event name.
o GetSourcePublisher(CATUnicodeString&,CATUnicodeString&,int&)
Gets the type publishing the event.
o GetTypeOfArgument(CATUnicodeString&,ENOVEvtArgType&)
Gets the type of a stream argument.
o GetVisibility(ENOVEvtType&)
Gets the visibility of the event.
o HasAssociatedData()
Checks if there is a data stream associated to the event.
o IsBeforeAfterMode()
Checks if the event has two steps.
o IsInstanceSubscribable()
Checks if the event is subscribe-able as far as instance objects are concerned.
o IsPersistentEvent()
Checks if the event is persistent.
o IsVetoAble()
Checks if the event is veto-able.

Methods


o GetAssociatedData
public virtual HRESULT GetAssociatedData(CATUnicodeString& oStreamName,
CATListOfCATUnicodeString& oArgumentNames)=0
Gets the data stream associated to the event.
Role : Retrieves the characteristics of an event stream.
Parameters:
oStreamName
string giving the name of the event stream
oArgumentNames
list of strings giving the names of the stream arguments
o GetCallBackInterfaceNames
public virtual HRESULT GetCallBackInterfaceNames(CATListOfCATUnicodeString& oInterfaceNames)=0
Gets the list of callback interfaces associated to the event.
Role : Retrieves the names of the callback interfaces.
Parameters:
oInterfaceNames
list of strings giving the names of the callback interfaces
o GetEventName
public virtual HRESULT GetEventName(CATUnicodeString& oEventName)=0
Gets the event name.
Role : Retrieves the name of the event.
Parameters:
oEventName
string giving the name of the event
o GetSourcePublisher
public virtual HRESULT GetSourcePublisher(CATUnicodeString& oPublisherType,
CATUnicodeString& oBelongingPackage,
int& oWhichLevel)=0
Gets the type publishing the event.
Role : Retrieves the type of the publishing object.
Parameters:
oPublisherType
string giving the type of the publishing object
oBelongingPackage
string giving the name of the package declaring the event
oWhichLevel
level of inheritance of the type
o GetTypeOfArgument
public virtual HRESULT GetTypeOfArgument( const CATUnicodeString& iArgumentName,
ENOVEvtArgType& oArgumentType)=0
Gets the type of a stream argument.
Role : Retrieves the name of the event.
Parameters:
oArgumentName
string giving the name of the stream argument
oArgumentType
enum value giving the type of the stream argument
o GetVisibility
public virtual HRESULT GetVisibility(ENOVEvtType& oVisibility)=0
Gets the visibility of the event.
Role : Retrieves the type of the event.
Parameters:
oVisibility
enum value giving the visibility of the event
o HasAssociatedData
public virtual CATBoolean HasAssociatedData()=0
Checks if there is a data stream associated to the event.
Role : Allows to know if the event has an associated stream of data.
Returns:
TRUE if there is a data stream
o IsBeforeAfterMode
public virtual CATBoolean IsBeforeAfterMode()=0
Checks if the event has two steps.
Role : Allows to know if the event is fired twice inside the scope of the corresponding method.
Returns:
TRUE if the event has two steps
o IsInstanceSubscribable
public virtual CATBoolean IsInstanceSubscribable()=0
Checks if the event is subscribe-able as far as instance objects are concerned.
Role : Allows to know if the event can be subscribed to on instances.
Returns:
TRUE if the event is subscribe-able
o IsPersistentEvent
public virtual CATBoolean IsPersistentEvent()=0
Checks if the event is persistent.
Role : Allows to know if the event is stored in the database.
Returns:
TRUE if the event is persistent
o IsVetoAble
public virtual CATBoolean IsVetoAble()=0
Checks if the event is veto-able.
Role : Allows to know if the event can be vetoed by a subscriber.
Returns:
TRUE if the event is veto-able

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

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