freesmartphone.org PIM.TaskQuery Interface

Description

This interface gives access to a task query.

Namespace

org.freesmartphone.PIM.TaskQuery

Methods

Signals

None

Properties

None

Errors

None

Methods

GetResultCount ( ) → i

Description: Return the number of items in the query result

Returns:

i: count Amount of tasks in the query result.

Rewind ( )

Description: Rewind the result cursor to the first task (for this dbus client only).

Skip ( i )

Description: Skip n tasks in the result cursor (for this dbus client only).

Parameters:*

i: count Amount of tasks to skip.

GetTaskPath ( ) → s

Description: Path for the task the result cursor points to.

Returns:

s: task_path The path to the task.

GetResult ( ) → a{sv}

Description: Return the next task in the query result, and move the query to the next task.

Returns:

a{sv}: item fields of the result.

GetMultipleResults ( i ) → aa{sv}

Description: Get multiple tasks from the result set at once.

Parameters:*

i: count The number of tasks to get from the result set. A negative value means all.

Returns:

aa{sv}: resultset The list of the returned tasks data.

Dispose ( )

Description: Delete the query result object.