QOrganizerItemFetchRequest Class

Member Function Documentation

QOrganizerItemFetchRequest::QOrganizerItemFetchRequest(QObject * parent = 0)

Constructs a new organizer item fetch request whose parent is the specified parent.

QOrganizerItemFetchRequest::~QOrganizerItemFetchRequest()

Frees memory in use by this request.

QDateTime QOrganizerItemFetchRequest::endDate() const

Returns the date-time which is the upper bound for the range in which items will be returned.

See also setEndDate().

QOrganizerItemFetchHint QOrganizerItemFetchRequest::fetchHint() const

Returns the fetch hint which may be used by the backend to optimize item retrieval.

A client should not make changes to a item which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the item back to the manager (as the "new" restricted item will replace the previously saved item in the backend).

See also setFetchHint().

QOrganizerItemFilter QOrganizerItemFetchRequest::filter() const

Returns the filter that will be used to select organizer items to be returned.

See also setFilter().

QList<QOrganizerItem> QOrganizerItemFetchRequest::items() const

Returns the list of organizer items retrieved by this request.

int QOrganizerItemFetchRequest::maxCount() const

Returns the maximum number of items to return for the request.

See also setMaxCount().

void QOrganizerItemFetchRequest::setEndDate(const QDateTime & date)

Sets the end period of the request to date.

A default-constructed (invalid) end date time specifies an open end date time (matches anything which occurs after the start date time).

See also endDate().

void QOrganizerItemFetchRequest::setFetchHint(const QOrganizerItemFetchHint & fetchHint)

Sets the fetch hint which may be used by the backend to optimize item retrieval to fetchHint.

A client should not make changes to a item which has been retrieved using a fetch hint other than the default fetch hint. Doing so will result in information loss when saving the item back to the manager (as the "new" restricted item will replace the previously saved item in the backend).

See also fetchHint().

void QOrganizerItemFetchRequest::setFilter(const QOrganizerItemFilter & filter)

Sets the organizer item filter used to determine which organizer items will be retrieved to filter.

See also filter().

void QOrganizerItemFetchRequest::setMaxCount(int maxCount)

Sets the maximum number of items to be fetched to maxCount.

Note that backends will decide how many items are fetched if maxCount is negative.

See also maxCount().

void QOrganizerItemFetchRequest::setSorting(const QList<QOrganizerItemSortOrder> & sorting)

Sets the sort order of the result to sorting.

See also sorting().

void QOrganizerItemFetchRequest::setStartDate(const QDateTime & date)

Sets the start period of the request to date.

A default-constructed (invalid) start date time specifies an open start date time (matches anything which occurs up until the end date time).

See also startDate().

void QOrganizerItemFetchRequest::setStorageLocations(QOrganizerAbstractRequest::StorageLocations storageLocations)

Sets storage locations where the items are fetched from. storageLocations is a flag, so you can define multiple locations in it.

See also QOrganizerAbstractRequest::StorageLocation and QOrganizerItemFetchRequest::storageLocations().

QList<QOrganizerItemSortOrder> QOrganizerItemFetchRequest::sorting() const

Returns the sort ordering that will be used sort the results of this request.

See also setSorting().

QDateTime QOrganizerItemFetchRequest::startDate() const

Returns the date-time which is the lower bound for the range in which items will be returned.

See also setStartDate().

QOrganizerAbstractRequest::StorageLocations QOrganizerItemFetchRequest::storageLocations() const

Storage locations where the items are fetched from.

See also QOrganizerAbstractRequest::StorageLocation and QOrganizerItemFetchRequest::setStorageLocations().