MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QOrganizerItemFetchByIdRequest Class Reference

The QOrganizerItemFetchByIdRequest class allows a client to asynchronously request items from a items store manager, given a list of item IDs. More...

 #include <QOrganizerItemFetchByIdRequest>

Inherits: QOrganizerAbstractRequest.

This class was introduced in Qt Mobility 1.2.

Public Functions

QOrganizerItemFetchByIdRequest ( QObject * parent = 0 )
~QOrganizerItemFetchByIdRequest ()
QMap<int, QOrganizerManager::Error> errorMap () const
QOrganizerItemFetchHint fetchHint () const
QList<QOrganizerItemId> ids () const
QList<QOrganizerItem> items () const
void setFetchHint ( const QOrganizerItemFetchHint & fetchHint )
void setIds ( const QList<QOrganizerItemId> & ids )

Additional Inherited Members

Detailed Description

The QOrganizerItemFetchByIdRequest class allows a client to asynchronously request items from a items store manager, given a list of item IDs.

The items fetched by the backend should have a one-to-one correspondence to the IDs passed into this class. That is, the nth item in the returned list should have an ID which is equal to the nth ID in the list of IDs. Any invalid ID should correspond to an empty QOrganizerItem.

For a QOrganizerItemFetchByIdRequest, the resultsAvailable() signal will be emitted when the resultant items (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.

Please see the class documentation of QOrganizerAbstractRequest for more information about the usage of request classes and ownership semantics.

Member Function Documentation

QOrganizerItemFetchByIdRequest::QOrganizerItemFetchByIdRequest ( QObject * parent = 0 )

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

This function was introduced in Qt Mobility 1.2.

QOrganizerItemFetchByIdRequest::~QOrganizerItemFetchByIdRequest ()

Frees any memory used by this request

This function was introduced in Qt Mobility 1.2.

QMap<int, QOrganizerManager::Error> QOrganizerItemFetchByIdRequest::errorMap () const

Returns the map of input definition list indices to errors which occurred

This function was introduced in Qt Mobility 1.2.

QOrganizerItemFetchHint QOrganizerItemFetchByIdRequest::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).

This function was introduced in Qt Mobility 1.2.

See also setFetchHint() and QOrganizerItemFetchHint.

QList<QOrganizerItemId> QOrganizerItemFetchByIdRequest::ids () const

Returns the list of ids of the items that the backend should retrieve.

This function was introduced in Qt Mobility 1.2.

See also setIds().

QList<QOrganizerItem> QOrganizerItemFetchByIdRequest::items () const

Returns the list of items retrieved by this request

This function was introduced in Qt Mobility 1.2.

void QOrganizerItemFetchByIdRequest::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).

This function was introduced in Qt Mobility 1.2.

See also fetchHint() and QOrganizerItemFetchHint.

void QOrganizerItemFetchByIdRequest::setIds ( const QList<QOrganizerItemId> & ids )

Sets the list of ids of the items that the backend should retrieve to ids.

This function was introduced in Qt Mobility 1.2.

See also ids().