Managed Object - ConverterEventManager

Property of
ConverterHelperServiceContent, ConverterServiceContent
See also
ConverterEvent, ConverterEventDescription, ConverterEventFilterSpec, ConverterEventHistoryCollector
Since
Converter API 1.0


Managed Object Description

This managed object type provides properties and methods for event management support.

Properties

Name Type Description
descriptionConverterEventDescription

Static descriptive strings used in events.
maxCollectorxsd:int

For each client, the maximum number of event collectors that can exist simultaneously.

Methods

Methods defined in this Managed Object
ConverterCreateCollectorForEvents, ConverterQueryEvents

ConverterCreateCollectorForEvents

Creates an event history collector, which is a specialized history collector that provides Event objects.

Event collectors do not persist beyond the current client session.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterEventManager used to make the method call.
filter PConverterEventFilterSpec

The event query filter.

Since Converter API 1.0
P Required privilege: filter

Return Value

Type Description
ManagedObjectReference
to a ConverterEventHistoryCollector
The event collector based on the filter.

Faults

Type Description
InvalidStateThrown if there are more than the maximum number of event collectors.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterQueryEvents

Returns the events in specified filter. Returns empty array when there are not any events qualified.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterEventManager used to make the method call.
filter PConverterEventFilterSpec

The events qualified.

Since Converter API 1.0
P Required privilege: filter

Return Value

Type Description
ConverterEvent[]The events in the chain.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None