All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMPersistency Class ENOVPubSubDetails
ENOVPubSubDetails
Usage: you must use this class as is. You should never derive it.
public class ENOVPubSubDetails
Class to collect information about Publish & Subscribe persistent data.
Role:
This class groups methods to retrieve information about specific Pub/Sub data.
Method Index
- o
CountSubscriptionFilters()
- Gets the number of filters applied to the subscription.
- o
GetEventName()
- Gets the event name.
- o
GetPubSubDate()
- Gets the date of subscription / notification.
- o
GetPublisherBizType()
- Gets the publisher business type.
- o
GetPublisherDomain()
- Gets the publisher business domain.
- o
GetPublisherName()
- Gets the publisher name.
- o
GetPublisherOid()
- Gets the publisher OID.
- o
GetPublisherType()
- Gets the publisher modeler type.
- o
GetSubscriber()
- Gets the subscriber ID.
- o
GetSubscriberType()
- Gets the type of the subscriber.
- o
GetSubscriptionFilters()
- Gets the list of subscription filters.
- o
GetSubscriptionType()
- Gets the type of the subscription.
Methods
o CountSubscriptionFilters
public int CountSubscriptionFilters( | ) |
-
Gets the number of filters applied to the subscription.
Role : Counts the number of filters.
- Returns:
- the number of applied subscription filters
o GetEventName
-
Gets the event name.
Role : Retrieves the name of the event.
- Returns:
- a string giving the name of the event
o GetPubSubDate
-
Gets the date of subscription / notification.
Role : Retrieves the date of subscription or notification
- Returns:
- a string giving the data of subscription or notification in the following format:
YYYY-MM-DD-HH.MM.SS.XXXXXX
o GetPublisherBizType
-
Gets the publisher business type.
Role : Retrieves the business type of the publisher.
- Returns:
- a string giving the business type of the publishing object if it exists, its modeler type otherwise
o GetPublisherDomain
-
Gets the publisher business domain.
Role : Retrieves the business domain of the publisher.
- Returns:
- a string giving the business domain of the publishing object
o GetPublisherName
-
Gets the publisher name.
Role : Retrieves the name of the publisher.
- Returns:
- a string giving the name of the publishing object (
ENOVINamedObject )
o GetPublisherOid
-
Gets the publisher OID.
Role : Retrieves the OID of the publisher.
- Returns:
- the database OID of the publishing object
o GetPublisherType
-
Gets the publisher modeler type.
Role : Retrieves the modeler type of the publisher.
- Returns:
- a string giving the modeler type of the publishing object
o GetSubscriber
-
Gets the subscriber ID.
Role : Retrieves the ID of the subscriber.
- Returns:
- a string identifying an ENOVIA user
o GetSubscriberType
public int GetSubscriberType( | )const |
-
Gets the type of the subscriber.
Role : Retrieves the type of subscriber.
- Returns:
- 0 for real subscribers, 2 for subscriber profiles
o GetSubscriptionFilters
-
Gets the list of subscription filters.
Role : Retrieves the list of filters.
- Returns:
- a list of filters (
ENOVEventSubFilter )
o GetSubscriptionType
public int GetSubscriptionType( | )const |
-
Gets the type of the subscription.
Role : Retrieves the type of subscription.
- Returns:
- 0 for subscriptions on instance, 1 for subscriptions on type
This object is included in the file: ENOVPubSubDetails.h
If needed, your Imakefile.mk should include the module: VX0FACTO