All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

VPMPersistency Interface ENOVIPubSubManager

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

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


interface ENOVIPubSubManager

Interface to manage the persistent and asynchronous part of the ENOVIA Event Model.
Role:
This interface groups methods to manage persistent data related to events:
- Information about the Events that users can subscribe to.
- Subscription to/Unsubscription from events by users.
- Information about Subscriptions.
- Information about Published Events.


Method Index


o BuildListOfSubFilter(CATListOfENOVEventSubFilter&,CATUnicodeString&,CATUnicodeString&,CORBAAny&)
Defines filters to be applied onto a subscription.
o FreePubSubDetails(CATListOfENOVPubSubDetails&)
Deletes an allocated list of subscriptions or published events.
o FreeSubFilters(CATListOfENOVEventSubFilter&)
Deletes an allocated list of subscription filters.
o GetAllKnownEvents(CATListOfCATUnicodeString&)
Gives the list of all existing persistent events.
o GetAllMyPublishedEvents(CATUnicodeString&,CATListOfENOVPubSubDetails&)
Gives the list of published events a user subscribed to.
o GetAllMySubscriptions(CATUnicodeString&,CATListOfENOVPubSubDetails&,short)
Gives the list of all subscriptions made by a user.
o GetMySubscription(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVPubSubDetails*&)
o GetMySubscription(CATUnicodeString&,ENOVIPublisher_var&,CATUnicodeString&,ENOVPubSubDetails*&)
Gives the subscription made by a user for a given object instance and event name.
o GetMySubscriptions(CATUnicodeString&,CATUnicodeString&,CATListOfENOVPubSubDetails&)
o GetMySubscriptions(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfENOVPubSubDetails&,short)
Gives the list of some subscriptions made by a user.
o GetMySubscriptions(CATUnicodeString&,ENOVIPublisher_var&,CATListOfENOVPubSubDetails&)
Gives the list of subscriptions made by a user for a given object instance.
o GetRaisableEventDefs(CATUnicodeString&,CATListOfENOVIEventDefinition&,short)
Gives the list of event definitions a type of modeler object can raise.
o GetSubscribers(CATUnicodeString&,CATListOfCATUnicodeString&)
Gives the list of subscribers for a given modeler object type.
o GetSubscribers(CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&)
Gives the list of subscribers for a given modeler object type and event name.
o GetSubscribers(ENOVIPublisher_var&,CATListOfCATUnicodeString&)
Gives the list of subscribers for a given object instance.
o GetSubscribers(ENOVIPublisher_var&,CATUnicodeString&,CATListOfCATUnicodeString&)
Gives the list of subscribers for a given object instance and event name.
o GetSubscribersOnEvent(CATUnicodeString&,CATListOfCATUnicodeString&)
Gives the list of subscribers for a given event name.
o QueryAllPublishedEvents(CATListOfENOVPubSubDetails&)
Gives the list of published events subscribed to by all users.
o QueryAllSubscriptions(CATListOfENOVPubSubDetails&)
Gives the list of subscriptions made by all users.
o RemoveAllMyPublishedEvents(CATUnicodeString&)
Deletes all published events.
o RemovePublishedEvent(CATUnicodeString&,CATUnicodeString&,CATDbBinary&,CATUnicodeString&)
o RemovePublishedEvents(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Deletes published events, raised according to a given instance or type subscription.
o Subscribe(CATUnicodeString&,CATUnicodeString&,CATDbBinary&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfENOVEventSubFilter&)
o Subscribe(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATDbBinary&,CATUnicodeString&,CATListOfENOVEventSubFilter&)
Subscribes to an event raised by a given object instance.
o Subscribe(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfENOVEventSubFilter&)
Subscribes to an event raised by a given object type.
o Subscribe(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfENOVEventSubFilter&)
o Subscribe(CATUnicodeString&,ENOVIPublisher_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfENOVEventSubFilter&)
Subscribes to an event raised by a given object instance.
o Unsubscribe(CATUnicodeString&,CATUnicodeString&,CATDbBinary&,CATUnicodeString&)
o Unsubscribe(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
o Unsubscribe(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATDbBinary&,CATUnicodeString&)
Unsubscribes to an event raised by a given object instance.
o Unsubscribe(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Unsubscribes to an event raised by a given object type.
o Unsubscribe(CATUnicodeString&,ENOVIPublisher_var&,CATUnicodeString&)
Unsubscribes to an event raised by a given object instance.
o UnsubscribeAll(CATUnicodeString&)
Unsubscribes to all events.

Methods


o BuildListOfSubFilter
public virtual HRESULT BuildListOfSubFilter(CATListOfENOVEventSubFilter& ioSubFilterList,
const CATUnicodeString& iCategory,
const CATUnicodeString& iName,
const CORBAAny& iValue)=0
Defines filters to be applied onto a subscription.
Role : Builds a list of filters before calling a Subscribe method.
Parameters:
ioSubFilterList
the current list of filters (
ENOVEventSubFilter )
iCategory
the category of the filter
iName
the name of the filter
iValue
the value of the filter
o FreePubSubDetails
public virtual void FreePubSubDetails(CATListOfENOVPubSubDetails& iPubSubDetails)=0
Deletes an allocated list of subscriptions or published events.
Role : Allows to deallocate lists of details returned by methods:
GetAllMySubscriptions, GetMySubscriptions, QueryAllSubscriptions
GetAllMyPublishedEvents, QueryAllPublishedEvents
Parameters:
iPubSubDetails
the list of details to delete (
ENOVPubSubDetails )
o FreeSubFilters
public virtual void FreeSubFilters(CATListOfENOVEventSubFilter& iSubFilters)=0
Deletes an allocated list of subscription filters.
Role : Allows to deallocate lists of filters returned by method BuildListOfSubFilter.
Parameters:
iSubFilters
the list of filters to delete (
ENOVEventSubFilter )
o GetAllKnownEvents
public virtual HRESULT GetAllKnownEvents(CATListOfCATUnicodeString& oEventNamesList)=0
Gives the list of all existing persistent events.
Role : Retrieve the name of events users can subscribe to.
Parameters:
oEventNamesList
the list of persistent event names
o GetAllMyPublishedEvents
public virtual HRESULT GetAllMyPublishedEvents( const CATUnicodeString& iUser,
CATListOfENOVPubSubDetails& oPublishedEvents)=0
Gives the list of published events a user subscribed to.
Role : Retrieves the details of events raised for subscribers.
Parameters:
iUser
string identifying an ENOVIA user
oPublishedEvents
the list of published events this user subscribed to (
ENOVPubSubDetails )
o GetAllMySubscriptions
public virtual HRESULT GetAllMySubscriptions( const CATUnicodeString& iUser,
CATListOfENOVPubSubDetails& oSubscriptions,
const short iFilter= 1)=0
Gives the list of all subscriptions made by a user.
Role : Retrieves the details of all subscriptions made by users.
Parameters:
iUser
string identifying an ENOVIA user
oSubscriptions
the list of subscriptions this user made (
ENOVPubSubDetails )
iFilter
short for filtering on business types :
0 = no filter = all related subscriptions are returned
1 = filter = default; only one of the related subscriptions is returned
o GetMySubscription
public virtual HRESULT GetMySubscription( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iEventName,
ENOVPubSubDetails*& oSubscription)=0
Deprecated:
V5R14 ENOVIPubSubManager#GetMySubscriptions(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,CATListOfENOVPubSubDetails&,const short) Gives the subscription made by a user for a given object type and event name.
Role : Retrieves the details of a subscription made by users for given types and events.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherType.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherType
string giving the extended type of the publishing object in the specific concatened form: iPublisherDomain&iPublisherModType&iPublisherBizType where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherModType is the modeler type of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise.
iEventName
string giving the name of the event
oSubscription
the subscription this user made (
ENOVPubSubDetails )
Returns:
S_FALSE if this subscription does not exist
o GetMySubscription
public virtual HRESULT GetMySubscription( const CATUnicodeString& iUser,
const ENOVIPublisher_var& iPublisherInstance,
const CATUnicodeString& iEventName,
ENOVPubSubDetails*& oSubscription)=0
Gives the subscription made by a user for a given object instance and event name.
Role : Retrieves the details of a subscription made by users for given instances of modeler objects and events.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherInstance
the publisher view of the modeler object instance
iEventName
string giving the name of the event
oSubscription
the subscription this user made
Returns:
S_FALSE if this subscription does not exist
o GetMySubscriptions
public virtual HRESULT GetMySubscriptions( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherType,
CATListOfENOVPubSubDetails& oSubscriptions)=0
Deprecated:
V5R14 ENOVIPubSubManager#GetMySubscriptions(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,CATListOfENOVPubSubDetails&,const short) Gives the list of subscriptions made by a user for a given object type.
Role : Retrieves the details of subscriptions made by users for given types.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherType.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherType
string giving the extended type of the publishing object in the specific concatened form: iPublisherDomain&iPublisherModType&iPublisherBizType where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherModType is the modeler type of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise.
oSubscriptions
the list of subscriptions this user made (
ENOVPubSubDetails )
o GetMySubscriptions
public virtual HRESULT GetMySubscriptions( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherNameOrType,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iPublisherDomain,
const CATUnicodeString& iEventName,
CATListOfENOVPubSubDetails& oSubscriptions,
const short iFilter= 1)=0
Gives the list of some subscriptions made by a user.
Role : Retrieves the details of all subscriptions made by users for a given object instance or object type and, optionally, an event name.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherNameOrType
string giving either the name of the publishing object (
ENOVINamedObject ) to get the subscriptions on that instance or the business type of the publishing object if it exists, its modeler type otherwise, to get the subscriptions on that type
iPublisherType
string giving the business type of the publishing object if it exists, its modeler type otherwise
iPublisherDomain
string giving the business domain of the publishing object
iEventName
string giving the name of the event (can be an empty string)
oSubscriptions
the list of subscriptions this user made (
ENOVPubSubDetails )
iFilter
short for filtering on the business type :
0 = no filter = all related subscriptions are returned
1 = filter = default; only one of the related subscriptions is returned
o GetMySubscriptions
public virtual HRESULT GetMySubscriptions( const CATUnicodeString& iUser,
const ENOVIPublisher_var& iPublisherInstance,
CATListOfENOVPubSubDetails& oSubscriptions)=0
Gives the list of subscriptions made by a user for a given object instance.
Role : Retrieves the details of subscriptions made by users for given instances of modeler objects.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherInstance
the publisher view of the modeler object instance
oSubscriptions
the list of subscriptions this user made (
ENOVPubSubDetails )
o GetRaisableEventDefs
public virtual HRESULT GetRaisableEventDefs( const CATUnicodeString& iPublisherType,
CATListOfENOVIEventDefinition& oEventDefinitions,
const short onInstance=0 )=0
Gives the list of event definitions a type of modeler object can raise.
Role : Retrieve the definition of events users can subscribe to, for a given type of modeler object.
Parameters:
iPublisherType
string giving the modeler type of the publishing object
oEventDefinitions
the list of event definitions raised by this object type (
ENOVIEventDefinition )
onInstance
if not 0, returns events that can be subscribed on instances of this modeler object type
o GetSubscribers
public virtual HRESULT GetSubscribers( const CATUnicodeString& iPublisherType,
CATListOfCATUnicodeString& oSubscribers)=0
Gives the list of subscribers for a given modeler object type.
Role : Retrieves the subscribers for given modeler types.
Parameters:
iPublisherType
string giving the modeler type of the publishing object
oSubscribers
the list of subscribers
o GetSubscribers
public virtual HRESULT GetSubscribers( const CATUnicodeString& iPublisherType,
const CATUnicodeString& iEventName,
CATListOfCATUnicodeString& oSubscribers)=0
Gives the list of subscribers for a given modeler object type and event name.
Role : Retrieves the subscribers for given modeler types and events.
Parameters:
iPublisherType
string giving the modeler type of the publishing object
iEventName
string giving the name of the event
oSubscribers
the list of subscribers
o GetSubscribers
public virtual HRESULT GetSubscribers( const ENOVIPublisher_var& iPublisherInstance,
CATListOfCATUnicodeString& oSubscribers)=0
Gives the list of subscribers for a given object instance.
Role : Retrieves the subscribers for given instances.
Parameters:
iPublisherInstance
the publisher view of the object instance
oSubscribers
the list of subscribers
o GetSubscribers
public virtual HRESULT GetSubscribers( const ENOVIPublisher_var& iPublisherInstance,
const CATUnicodeString& iEventName,
CATListOfCATUnicodeString& oSubscribers)=0
Gives the list of subscribers for a given object instance and event name.
Role : Retrieves the subscribers for given instances and events.
Parameters:
iPublisherInstance
the publisher view of the object instance
iEventName
string giving the name of the event
oSubscribers
the list of subscribers
o GetSubscribersOnEvent
public virtual HRESULT GetSubscribersOnEvent( const CATUnicodeString& iEventName,
CATListOfCATUnicodeString& oSubscribers)=0
Gives the list of subscribers for a given event name.
Role : Retrieves the subscribers for given events.
Parameters:
iEventName
string giving the name of the event
oSubscribers
the list of subscribers
o QueryAllPublishedEvents
public virtual HRESULT QueryAllPublishedEvents(CATListOfENOVPubSubDetails& oPublishedEvents)=0
Gives the list of published events subscribed to by all users.
Role : Retrieves the details of events raised for all subscribers.
Parameters:
oPublishedEvents
the list of all published events (
ENOVPubSubDetails )
o QueryAllSubscriptions
public virtual HRESULT QueryAllSubscriptions(CATListOfENOVPubSubDetails& oSubscriptions)=0
Gives the list of subscriptions made by all users.
Role : Retrieves the details of subscriptions made by all users.
Parameters:
oSubscriptions
the list of all subscriptions (
ENOVPubSubDetails )
o RemoveAllMyPublishedEvents
public virtual HRESULT RemoveAllMyPublishedEvents( const CATUnicodeString& iUser)=0
Deletes all published events.
Role : Method allowing users to remove all persistent published events.
Parameters:
iUser
string identifying an ENOVIA user
o RemovePublishedEvent
public virtual HRESULT RemovePublishedEvent( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherName,
const CATDbBinary& iPublisherOID,
const CATUnicodeString& iEventName)=0
Deprecated:
V5R14 ENOVIPubSubManager#RemovePublishedEvents(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&) Deletes an event raised by a given object instance.
Role : Method allowing users to remove persistent published events.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherName.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherName
string giving the extended name of the publishing object in the specific concatened form: iPublisherDomain&iPublisherBizType&iPublisherName where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise;
  • iPublisherName is the name of the publishing object (
ENOVINamedObject ).
iPublisherOID
the database OID of the publishing object
iEventName
string giving the name of the event
o RemovePublishedEvents
public virtual HRESULT RemovePublishedEvents( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherNameOrType,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iPublisherDomain,
const CATUnicodeString& iEventName)=0
Deletes published events, raised according to a given instance or type subscription.
Role : Method allowing users to remove persistent published events coming from an instance or type subscription.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherNameOrType
string giving either the name of the publishing object (
ENOVINamedObject ) to remove published events related to subscriptions on that instance or the business type of the publishing object if it exists, its modeler type otherwise, to remove published events related to subscriptions on that type
iPublisherType
string giving the business type of the publishing object if it exists, its modeler type otherwise
iPublisherDomain
string giving the business domain of the publishing object
iEventName
string giving the name of the event
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherName,
const CATDbBinary& iPublisherOID,
const CATUnicodeString& iEventName,
const CATUnicodeString& iMailTo= "",
const CATUnicodeString& iMailShell= "",
const CATUnicodeString& iMailData= "",
const CATListOfENOVEventSubFilter& iSubFilterList= NULL)=0
Deprecated:
V5R14 ENOVIPubSubManager#Subscribe(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATDbBinary&,const CATUnicodeString&,CATListOfENOVEventSubFilter&) Subscribes to an event raised by a given object instance.
Role : Method allowing users to persistently subscribe on instances.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherName.
Also all mail related parameters will next be handled in an ENOVEventSubFilter object.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherName
string giving the extended name of the publishing object in the specific concatened form: iPublisherDomain&iPublisherBizType&iPublisherName where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise;
  • iPublisherName is the name of the publishing object (
ENOVINamedObject ).
iPublisherOID
the database OID of the publishing object
iEventName
string giving the name of the event
iMailTo
string giving the user email
iMailShell
string giving the shell to be used for notification
iMailData
additional data to be added to the notification
iSubFilterList
the list of filters applied to this subscription (
ENOVEventSubFilter )
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherName,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iPublisherDomain,
const CATDbBinary& iPublisherOID,
const CATUnicodeString& iEventName,
const CATListOfENOVEventSubFilter& iSubFilterList= NULL)=0
Subscribes to an event raised by a given object instance.
Role : Method allowing users to persistently subscribe on instances.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherName
string giving the name of the publishing object (
ENOVINamedObject )
iPublisherType
string giving the business type of the publishing object if it exists, its modeler type otherwise
iPublisherDomain
string giving the business domain of the publishing object
iPublisherOID
the database OID of the publishing object
iEventName
string giving the name of the event
iSubFilterList
the list of filters applied to this subscription (
ENOVEventSubFilter )
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherModType,
const CATUnicodeString& iPublisherBizType,
const CATUnicodeString& iPublisherDomain,
const CATUnicodeString& iEventName,
const CATListOfENOVEventSubFilter& iSubFilterList= NULL)=0
Subscribes to an event raised by a given object type.
Role : Method allowing users to persistently subscribe on types.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherModType
string giving the modeler type of the publishing object
iPublisherBizType
string giving the business type of the publishing object if it exists, its modeler type otherwise
iPublisherDomain
string giving the business domain of the publishing object
iEventName
string giving the name of the event
iSubFilterList
the list of filters applied to this subscription (
ENOVEventSubFilter )
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iEventName,
const CATUnicodeString& iMailTo= "",
const CATUnicodeString& iMailShell= "",
const CATUnicodeString& iMailData= "",
const CATListOfENOVEventSubFilter& iSubFilterList= NULL)=0
Deprecated:
V5R14 ENOVIPubSubManager#Subscribe(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,CATListOfENOVEventSubFilter&) Subscribes to an event raised by a given object type.
Role : Method allowing users to persistently subscribe on types.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherType.
Also all mail related parameters will next be handled in an ENOVEventSubFilter object.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherType
string giving the extended type of the publishing object in the specific concatened form: iPublisherDomain&iPublisherModType&iPublisherBizType where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherModType is the modeler type of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise.
iEventName
string giving the name of the event
iMailTo
string giving the user email
iMailShell
string giving the shell to be used for notification
iMailData
additional data to be added to the notification
iSubFilterList
the list of filters applied to this subscription (
ENOVEventSubFilter )
o Subscribe
public virtual HRESULT Subscribe( const CATUnicodeString& iUser,
const ENOVIPublisher_var& iPublisherInstance,
const CATUnicodeString& iEventName,
const CATUnicodeString& iMailTo= "",
const CATUnicodeString& iMailShell= "",
const CATUnicodeString& iMailData= "",
const CATListOfENOVEventSubFilter& iSubFilterList= NULL)=0
Subscribes to an event raised by a given object instance.
Role : Method allowing users to persistently subscribe on instances.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherInstance
the publisher view of the object instance
iEventName
string giving the name of the event
iMailTo
string giving the user email
iMailShell
string giving the shell to be used for notification
iMailData
additional data to be added to the notification
iSubFilterList
the list of filters applied to this subscription (
ENOVEventSubFilter )
o Unsubscribe
public virtual HRESULT Unsubscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherName,
const CATDbBinary& iPublisherOID,
const CATUnicodeString& iEventName)=0
Deprecated:
V5R14 ENOVIPubSubManager#Unsubscribe(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATDbBinary&,const CATUnicodeString&) Unsubscribes to an event raised by a given object instance.
Role : Method allowing users to remove persistent subscriptions on instances.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherName.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherName
string giving the extended name of the publishing object in the specific concatened form: iPublisherDomain&iPublisherBizType&iPublisherName where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise;
  • iPublisherName is the name of the publishing object (
ENOVINamedObject ).
iPublisherOID
the database OID of the publishing object
iEventName
string giving the name of the event
o Unsubscribe
public virtual HRESULT Unsubscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iEventName)=0
Deprecated:
V5R14 ENOVIPubSubManager#Unsubscribe(const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&,const CATUnicodeString&) Unsubscribes to an event raised by a given object type.
Role : Method allowing users to remove persistent subscriptions on types.
This method has been deprecated to avoid the clumsy concatenation in parameter iPublisherType.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherType
string giving the extended type of the publishing object in the specific concatened form: iPublisherDomain&iPublisherModType&iPublisherBizType where
  • iPublisherDomain is the business domain of the publishing object;
  • iPublisherModType is the modeler type of the publishing object;
  • iPublisherBizType is the business type of the publishing object if it exists or its modeler type otherwise.
iEventName
string giving the name of the event
o Unsubscribe
public virtual HRESULT Unsubscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherName,
const CATUnicodeString& iPublisherType,
const CATUnicodeString& iPublisherDomain,
const CATDbBinary& iPublisherOID,
const CATUnicodeString& iEventName)=0
Unsubscribes to an event raised by a given object instance.
Role : Method allowing users to remove persistent subscriptions on instances.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherName
string giving the name of the publishing object (
ENOVINamedObject )
iPublisherType
string giving the business type of the publishing object if it exists, its modeler type otherwise
iPublisherDomain
string giving the business domain of the publishing object
iPublisherOID
the database OID of the publishing object
iEventName
string giving the name of the event
o Unsubscribe
public virtual HRESULT Unsubscribe( const CATUnicodeString& iUser,
const CATUnicodeString& iPublisherModType,
const CATUnicodeString& iPublisherBizType,
const CATUnicodeString& iPublisherDomain,
const CATUnicodeString& iEventName)=0
Unsubscribes to an event raised by a given object type.
Role : Method allowing users to remove persistent subscriptions on types.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherModType
string giving the modeler type of the publishing object
iPublisherBizType
string giving the business type of the publishing object if it exists, its modeler type otherwise
iPublisherDomain
string giving the business domain of the publishing object
iEventName
string giving the name of the event
o Unsubscribe
public virtual HRESULT Unsubscribe( const CATUnicodeString& iUser,
const ENOVIPublisher_var& iPublisherInstance,
const CATUnicodeString& iEventName)=0
Unsubscribes to an event raised by a given object instance.
Role : Method allowing users to remove persistent subscriptions on instances.
Parameters:
iUser
string identifying an ENOVIA user
iPublisherInstance
the publisher view of the object instance
iEventName
string giving the name of the event
o UnsubscribeAll
public virtual HRESULT UnsubscribeAll( const CATUnicodeString& iUser)=0
Unsubscribes to all events.
Role : Method allowing users to remove all persistent subscriptions.
Parameters:
iUser
string identifying an ENOVIA user

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

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