Managed Object - ConverterTaskHistoryCollector

Returned by
ConverterCreateCollectorForTasks
Extends
ConverterHistoryCollector
See also
ConverterTaskInfo
Since
Converter API 1.0


Managed Object Description

TaskHistoryCollector provides a mechanism for retrieving historical data and updates when the server appends new tasks.

Properties

Name Type Description
latestPage*ConverterTaskInfo[]

The items in the '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 allowed (by 'setLatestPageSize').
Properties inherited from ConverterHistoryCollector
filter
*May not be present

Methods

Methods defined in this Managed Object
ConverterReadNextTasks, ConverterReadPreviousTasks
Methods inherited from ConverterHistoryCollector
ConverterDestroyCollector, ConverterResetCollector, ConverterRewindCollector, ConverterSetCollectorPageSize

ConverterReadNextTasks

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.

The tasks are retrieved in the order from the newest item to the oldest item.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterTaskHistoryCollector 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
ConverterTaskInfo[]

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



ConverterReadPreviousTasks

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

The tasks are retrieved in the order from the newest item to the oldest item.

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterTaskHistoryCollector 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
ConverterTaskInfo[]

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