QOrganizerItemFetchByIdRequest Class

The QOrganizerItemFetchByIdRequest class allows a client to asynchronously fetch items from a backend, given a list of item IDs. More...

Header: #include <QOrganizerItemFetchByIdRequest>
Inherits: QOrganizerAbstractRequest.

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 fetch items from a backend, 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.

Member Function Documentation

QOrganizerItemFetchByIdRequest::QOrganizerItemFetchByIdRequest(QObject * parent = 0)

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

QOrganizerItemFetchByIdRequest::~QOrganizerItemFetchByIdRequest()

Frees any memory used by this request.

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

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

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).

See also setFetchHint().

QList<QOrganizerItemId> QOrganizerItemFetchByIdRequest::ids() const

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

See also setIds().

QList<QOrganizerItem> QOrganizerItemFetchByIdRequest::items() const

Returns the list of items retrieved by this request.

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).

See also fetchHint().

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

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

See also ids().