Qt Mobility Reference Documentation

QOrganizerItemFetchHint Class Reference

The QOrganizerItemFetchHint class provides hints to the manager about which organizeritem information needs to be retrieved in an asynchronous fetch request or a synchronous function call. More...

 #include <QOrganizerItemFetchHint>

Public Types

enum OptimizationHint { AllRequired, NoBinaryBlobs }
flags OptimizationHints

Public Functions

QOrganizerItemFetchHint ()
QOrganizerItemFetchHint ( const QOrganizerItemFetchHint & other )
~QOrganizerItemFetchHint ()
QStringList detailDefinitionsHint () const
OptimizationHints optimizationHints () const
void setDetailDefinitionsHint ( const QStringList & definitionNames )
void setOptimizationHints ( OptimizationHints hints )
QOrganizerItemFetchHint & operator= ( const QOrganizerItemFetchHint & other )

Detailed Description

The QOrganizerItemFetchHint class provides hints to the manager about which organizeritem information needs to be retrieved in an asynchronous fetch request or a synchronous function call.

All of the hints may be ignored at the discretion of the manager, however if a manager is able to optimize retrieval of organizeritems due to hints, it may do so. If a manager ignores a hint, it must retrieve the full set of data that the hint refers to.

The fetch hint contains:

  • a list of detail definition names which the client is interested in (empty if interested in all detail definitions)
  • some optimization flags which allow the client to tell the backend if they are not interested in binary blobs (images etc).

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


Member Type Documentation

enum QOrganizerItemFetchHint::OptimizationHint
flags QOrganizerItemFetchHint::OptimizationHints

This enum defines flags which may be set to inform the backend that the client does not require certain information. The backend may safely ignore the hint, but then must return the full set of information relating to the optimization hint.

ConstantValueDescription
QOrganizerItemFetchHint::AllRequired0x0Tells the backend that all information is required Tells the backend that the client does not require retrieved organizeritems to include a cache of action preferences
QOrganizerItemFetchHint::NoBinaryBlobs0x4Tells the backend that the client does not require retrieved organizeritems to include binary blobs such as thumbnail images

The OptimizationHints type is a typedef for QFlags<OptimizationHint>. It stores an OR combination of OptimizationHint values.


Member Function Documentation

QOrganizerItemFetchHint::QOrganizerItemFetchHint ()

Constructs a new organizeritem fetch hint which requests that the backend fetch all information

QOrganizerItemFetchHint::QOrganizerItemFetchHint ( const QOrganizerItemFetchHint & other )

Constructs a new organizeritem fetch hint as a copy of other

QOrganizerItemFetchHint::~QOrganizerItemFetchHint ()

Frees any memory in use by the fetch hint

QStringList QOrganizerItemFetchHint::detailDefinitionsHint () const

Returns the list of definition names that identify detail definitions of which details the manager should (at a minimum) retrieve when fetching organizeritems. This hint may be ignored by the backend, in which case it will return the full set of details for each organizeritem retrieved.

See also setDetailDefinitionsHint().

OptimizationHints QOrganizerItemFetchHint::optimizationHints () const

Returns the optimization hint flags specified by the client. These hints may be ignored by the backend, in which case it will return the full set of information accessible in a organizeritem, including relationships and binary blobs.

See also setOptimizationHints().

void QOrganizerItemFetchHint::setDetailDefinitionsHint ( const QStringList & definitionNames )

Sets the list of definition names that identify detail definitions of which details the manager should (at a minimum) retrieve when fetching organizeritems to definitionNames. This hint may be ignored by the backend, in which case it will return the full set of details for each organizeritem retrieved.

See also detailDefinitionsHint().

void QOrganizerItemFetchHint::setOptimizationHints ( OptimizationHints hints )

Sets the optimization hint flags specified by the client to hints. These hints may be ignored by the backend, in which case it will return the full set of information accessible in a organizeritem, including relationships and binary blobs.

See also optimizationHints().

QOrganizerItemFetchHint & QOrganizerItemFetchHint::operator= ( const QOrganizerItemFetchHint & other )

Assigns this fetch hint to be equal to the other fetch hint


Copyright © 2009-2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.1.0