Detailed Description
The QOrganizerItemFetchRequest class allows a client to asynchronously request organizer items from an organizer item store manager.
For a QOrganizerItemFetchRequest, the resultsAvailable() signal will be emitted when the resultant organizer item (which may be retrieved by calling items()), are updated, as well as if the overall operation error (which may be retrieved by calling error()) is updated.
Member Function Documentation
QOrganizerItemFetchRequest::QOrganizerItemFetchRequest ( QObject * parent = 0 )
Constructs a new organizer item fetch request whose parent is the specified parent
QDateTime QOrganizerItemFetchRequest::endDate () const
Returns the end date of the request. The end date is the upper bound of the time-period within which an item must occur (that is, either it or one of its occurrences must have a time-period defined by its start-date and end-date which overlaps with the time-period defined in this request) in order to be returned by the request.
An empty or invalid end date signifies an end date of positive-infinity (that is, all items which occur at any point in time after the start date, will be returned).
See also setEndDate().
QOrganizerItemFetchHint QOrganizerItemFetchRequest::fetchHint () const
Returns the fetch hint which may be used by the backend to optimize organizer item retrieval. A client should not make changes to an organizer 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 organizer item back to the manager (as the "new" restricted organizer item will replace the previously saved organizer item in the backend).
See also setFetchHint() and QOrganizerItemFetchHint.
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
void QOrganizerItemFetchRequest::setEndDate ( const QDateTime & date )
Sets the end period of the request to date. Only has an effect if called prior to calling start()
See also endDate().
void QOrganizerItemFetchRequest::setFetchHint ( const QOrganizerItemFetchHint & fetchHint )
Sets the fetch hint which may be used by the backend to optimize organizer item retrieval to fetchHint. A client should not make changes to a organizer 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 organizer item back to the manager (as the "new" restricted organizer item will replace the previously saved organizer item in the backend).
See also fetchHint() and QOrganizerItemFetchHint.
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::setSorting ( const QList<QOrganizerItemSortOrder> & sorting )
Sets the sort order of the result to sorting. Only has an effect if called prior to calling start()
See also sorting().
void QOrganizerItemFetchRequest::setStartDate ( const QDateTime & date )
Sets the start period of the request to date. Only has an effect if called prior to calling start()
See also startDate().
Returns the sort ordering that will be used sort the results of this request
See also setSorting().
QDateTime QOrganizerItemFetchRequest::startDate () const
Returns the start date of the request. The start date is the lower bound of the time-period within which an item must occur (that is, either it or one of its occurrences must have a time-period defined by its start-date and end-date which overlaps with the time-period defined in this request) in order to be returned by the request.
An empty or invalid start date signifies a start date of negative-infinity (that is, all items which occur at any point in time, up until the end date, will be returned).
See also setStartDate().
