Managed Object - ConverterEventHistoryCollector

Returned by
ConverterCreateCollectorForEvents
Extends
ConverterHistoryCollector
See also
ConverterEvent
Since
Converter API 1.0


Managed Object Description

EventHistoryCollector provides a mechanism for retrieving historical data and updates when the server appends new events.

Properties

Name Type Description
latestPage*ConverterEvent[]

The items in 'viewable latest page'. As new items are added to the collector, they are appended at the end of the page. The oldest item is removed from the latest page whenever there are more items in the collector than the maximum established by setLatestPageSize.
Properties inherited from ConverterHistoryCollector
filter
*May not be present

Methods

Methods defined in this Managed Object
ConverterReadNextEvents, ConverterReadPreviousEvents
Methods inherited from ConverterHistoryCollector
ConverterDestroyCollector, ConverterResetCollector, ConverterRewindCollector, ConverterSetCollectorPageSize

ConverterReadNextEvents

Reads the 'scrollable view' from the current position. The scrollable position is moved to the next newer page after the read. No item is returned when the end of the collector is reached.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterEventHistoryCollector used to make the method call.
maxCount Pxsd:int

The maximum number of items in the page.

Since Converter API 1.0
P Required privilege: maxCount

Return Value

Type Description
ConverterEvent[]

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



ConverterReadPreviousEvents

Reads the 'scrollable view' from the current position. The scrollable position is moved to the next older page after the read. No item is returned when the head of the collector is reached.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterEventHistoryCollector used to make the method call.
maxCount Pxsd:int

The maximum number of items in the page.

Since Converter API 1.0
P Required privilege: maxCount

Return Value

Type Description
ConverterEvent[]

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