QOrganizerManager Class Reference

Member Function Documentation

QOrganizerManager::QOrganizerManager ( const QString & managerName = QString(), const QMap<QString, QString> & parameters = 0, QObject * parent = 0 )

Constructs a QOrganizerManager whose implementation is identified by managerName with the given parameters.

The parent QObject will be used as the parent of this QOrganizerManager.

If an empty managerName is specified, the default implementation for the platform will be used.

QOrganizerManager::QOrganizerManager ( const QString & managerName, int implementationVersion, const QMap<QString, QString> & parameters = 0, QObject * parent = 0 )

Constructs a QOrganizerManager whose backend has the name managerName and version implementationVersion, where the manager is constructed with the provided parameters.

The parent QObject will be used as the parent of this QOrganizerManager.

If an empty managerName is specified, the default implementation for the platform will be instantiated. If the specified implementation version is not available, the manager with the name managerName with the default implementation version is instantiated.

QOrganizerManager::QOrganizerManager ( QObject * parent )

Constructs a QOrganizerManager whose parent QObject is parent. The default implementation for the platform will be created.

QOrganizerManager::~QOrganizerManager ()

Frees the memory used by the QOrganizerManager

QStringList QOrganizerManager::availableManagers () [static]

Returns a list of available manager ids that can be used when constructing a QOrganizerManager. If an empty id is specified to the constructor, the first value in this list will be used instead.

QString QOrganizerManager::buildUri ( const QString & managerName, const QMap<QString, QString> & params, int implementationVersion = -1 ) [static]

Returns a URI that completely describes a manager implementation, datastore, and the parameters with which to instantiate the manager, from the given managerName, params and an optional implementationVersion

QOrganizerCollection QOrganizerManager::collection ( const QOrganizerCollectionId & collectionId ) const

Returns the collection identified by the given collectionId which is managed by this manager.

QList<QOrganizerCollection> QOrganizerManager::collections () const

Returns a list of all of the collections managed by this manager.

void QOrganizerManager::collectionsAdded ( const QList<QOrganizerCollectionId> & collectionIds ) [signal]

This signal is emitted at some point once the collections identified by collectionIds have been added to a datastore managed by this manager. This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.

void QOrganizerManager::collectionsChanged ( const QList<QOrganizerCollectionId> & collectionIds ) [signal]

This signal is emitted at some point once the metadata for the collections identified by collectionIds have been modified in a datastore managed by this manager. This signal is not emitted if one of the items in this collection has changed - itemsChanged() will be emitted instead. This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.

void QOrganizerManager::collectionsRemoved ( const QList<QOrganizerCollectionId> & collectionIds ) [signal]

This signal is emitted at some point once the collections identified by collectionIds have been removed from a datastore managed by this manager. This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.

QOrganizerCollection QOrganizerManager::compatibleCollection ( const QOrganizerCollection & original ) const

Returns a pruned or modified version of the original organizer collection which is valid and can be saved in the manager. The returned organizer collection might have meta data removed or arbitrarily changed.

QOrganizerItem QOrganizerManager::compatibleItem ( const QOrganizerItem & original ) const

Returns a pruned or modified version of the original organizer item which is valid and can be saved in the manager. The returned organizer item might have entire details removed or arbitrarily changed.

void QOrganizerManager::dataChanged () [signal]

This signal is emitted by the manager if its internal state changes, and it is unable to determine the changes which occurred, or if the manager considers the changes to be radical enough to require clients to reload all data. If this signal is emitted, no other signals will be emitted for the associated changes.

QOrganizerCollection QOrganizerManager::defaultCollection () const

Returns the id of the default collection managed by this manager

QOrganizerItemDetailDefinition QOrganizerManager::detailDefinition ( const QString & definitionName, const QString & organizeritemType ) const

Returns the definition identified by the given definitionName that is valid for the organizer items whose type is the given organizeritemType in this store, or a default-constructed QOrganizerItemDetailDefinition if no such definition exists

QMap<QString, QOrganizerItemDetailDefinition> QOrganizerManager::detailDefinitions ( const QString & organizeritemType ) const

Returns a map of identifier to detail definition for the registered detail definitions for items whose type is the given organizeritemType which are valid for the organizer items in this store

QOrganizerManager::Error QOrganizerManager::error () const

Return the error code of the most recent operation

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

Returns per-input error codes for the most recent operation. This function only returns meaningful information if the most recent operation was a batch operation. Each key in the map is the index of the element in the input list for which the error (whose error code is stored in the value for that key in the map) occurred during the batch operation.

See also error(), saveItems(), and removeItems().

QList<QOrganizerItemId> QOrganizerManager::extractIds ( const QList<QOrganizerItem> & items ) [static]

Return a list of QOrganizerItemId extracted from the items

QOrganizerManager * QOrganizerManager::fromUri ( const QString & storeUri, QObject * parent = 0 ) [static]

Constructs a QOrganizerManager whose implementation, store and parameters are specified in the given storeUri, and whose parent object is parent.

bool QOrganizerManager::hasFeature ( QOrganizerManager::ManagerFeature feature, const QString & organizeritemType = QOrganizerItemType::TypeEvent ) const

Returns true if the given feature feature is supported by the manager, for the specified type of organizer item organizeritemType

bool QOrganizerManager::isFilterSupported ( const QOrganizerItemFilter & filter ) const

Returns true if the given filter is supported natively by the manager, and false if the filter behaviour would be emulated.

Note: In some cases, the behaviour of an unsupported filter cannot be emulated. For example, a filter that requests organizer items that have changed since a given time depends on having that information available. In these cases, the filter will fail.

QOrganizerItem QOrganizerManager::item ( const QOrganizerItemId & organizeritemId, const QOrganizerItemFetchHint & fetchHint = QOrganizerItemFetchHint() ) const

Returns the organizer item in the database identified by organizeritemId.

If the organizer item does not exist, an empty, default constructed QOrganizerItem will be returned, and the error returned by error() will be QOrganizerManager::DoesNotExistError.

The fetchHint parameter describes the optimization hints that a manager may take. If the fetchHint is the default constructed hint, all existing details in the matching organizer item will be returned. 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 QOrganizerItemFetchHint.

QList<QOrganizerItemId> QOrganizerManager::itemIds ( const QOrganizerItemFilter & filter = QOrganizerItemFilter(), const QList<QOrganizerItemSortOrder> & sortOrders = QList<QOrganizerItemSortOrder> () ) const

Returns a list of organizer item ids that match the given filter, sorted according to the given list of sortOrders. Depending on the backend, this filtering operation may involve retrieving all organizer items.

QList<QOrganizerItemId> QOrganizerManager::itemIds ( const QDateTime & startDate, const QDateTime & endDate, const QOrganizerItemFilter & filter = QOrganizerItemFilter(), const QList<QOrganizerItemSortOrder> & sortOrders = QList<QOrganizerItemSortOrder> () ) const

Returns a list of organizer item ids of persisted items that match the given filter, sorted according to the given list of sortOrders, for any item which occurs (or has an occurrence which occurs) in the range specified by the given startDate and endDate, inclusive. A default-constructed (invalid) startDate specifies an open start date (matches anything which occurs up until the endDate), and a default-constructed (invalid) endDate specifies an open end date (matches anything which occurs after the startDate). If both the startDate and endDate are invalid, this function will return the ids of all items which match the filter criteria. Depending on the backend, this filtering operation may involve retrieving all organizer items.

QList<QOrganizerItem> QOrganizerManager::itemOccurrences ( const QOrganizerItem & parentItem, const QDateTime & periodStart = QDateTime(), const QDateTime & periodEnd = QDateTime(), int maxCount = -1, const QOrganizerItemFetchHint & fetchHint = QOrganizerItemFetchHint() ) const

Return the list of a maximum of maxCount organizer item instances which are occurrences of the given parentItem recurring item, which occur between the given periodStart date and the given periodEnd date, inclusive.

If periodStart is after periodEnd, the operation will fail. If maxCount is negative, it is backend specific as to how many occurrences will be returned. Some backends may return no instances, others may return some limited number of occurrences.

The fetchHint allows clients to specify which pieces of information they are interested or not interested in, to allow backends to optimise data retrieval if possible. Note that it is simply a hint; backends can ignore the fetchHint, but if they do so they must return the full item.

QList<QOrganizerItem> QOrganizerManager::items ( const QOrganizerItemFilter & filter = QOrganizerItemFilter(), const QList<QOrganizerItemSortOrder> & sortOrders = QList<QOrganizerItemSortOrder> (), const QOrganizerItemFetchHint & fetchHint = QOrganizerItemFetchHint() ) const

Returns a list of organizer items that match the given filter, sorted according to the given list of sortOrders.

This function will return both persisted and generated occurrences of items which match the specified filter.

Depending on the manager implementation, this filtering operation might be slow and involve retrieving all organizer items and testing them against the supplied filter - see the isFilterSupported() function.

The fetchHint parameter describes the optimization hints that a manager may take. If the fetchHint is the default constructed hint, all existing details in the matching organizer items will be returned. 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 QOrganizerItemFetchHint.

QList<QOrganizerItem> QOrganizerManager::items ( const QDateTime & startDate, const QDateTime & endDate, const QOrganizerItemFilter & filter = QOrganizerItemFilter(), const QList<QOrganizerItemSortOrder> & sortOrders = QList<QOrganizerItemSortOrder> (), const QOrganizerItemFetchHint & fetchHint = QOrganizerItemFetchHint() ) const

Returns a list of organizer items that match the given filter, sorted according to the given list of sortOrders, for any item or occurrence of an item which occurs in the range specified by the given startDate and endDate, inclusive. A default-constructed (invalid) startDate specifies an open start date (matches anything which occurs up until the endDate), and a default-constructed (invalid) endDate specifies an open end date (matches anything which occurs after the startDate). If both the startDate and endDate are invalid, this function will return all items which match the filter criteria.

This function will return both persisted and generated occurrences of items which match the specified criteria.

Depending on the manager implementation, this filtering operation might be slow and involve retrieving all organizer items and testing them against the supplied filter - see the isFilterSupported() function.

The fetchHint parameter describes the optimization hints that a manager may take. If the fetchHint is the default constructed hint, all existing details in the matching organizer items will be returned. 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 QOrganizerItemFetchHint.

void QOrganizerManager::itemsAdded ( const QList<QOrganizerItemId> & itemIds ) [signal]

This signal is emitted at some point once the items identified by itemIds have been added to a datastore managed by this manager. This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.

void QOrganizerManager::itemsChanged ( const QList<QOrganizerItemId> & itemIds ) [signal]

This signal is emitted at some point once the items identified by itemIds have been modified in a datastore managed by this manager. This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.

QList<QOrganizerItem> QOrganizerManager::itemsForExport ( const QDateTime & startDate = QDateTime(), const QDateTime & endDate = QDateTime(), const QOrganizerItemFilter & filter = QOrganizerItemFilter(), const QList<QOrganizerItemSortOrder> & sortOrders = QList<QOrganizerItemSortOrder> (), const QOrganizerItemFetchHint & fetchHint = QOrganizerItemFetchHint() ) const

Returns a list of organizer items that match the given filter, sorted according to the given list of sortOrders, for any item which occurs (or has an occurrence which occurs) in the range specified by the given startDate and endDate, inclusive. A default-constructed (invalid) startDate specifies an open start date (matches anything which occurs up until the endDate), and a default-constructed (invalid) endDate specifies an open end date (matches anything which occurs after the startDate). If both the startDate and endDate are invalid, this function will return all items which match the filter criteria.

This function will only return parent items and persisted exceptions which match the specified criteria; not generated occurrences.

Depending on the manager implementation, this filtering operation might be slow and involve retrieving all organizer items and testing them against the supplied filter - see the isFilterSupported() function.

The fetchHint parameter describes the optimization hints that a manager may take. If the fetchHint is the default constructed hint, all existing details in the matching organizer items will be returned. 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 QOrganizerItemFetchHint.

void QOrganizerManager::itemsRemoved ( const QList<QOrganizerItemId> & itemIds ) [signal]

This signal is emitted at some point once the items identified by itemIds have been removed from a datastore managed by this manager. This signal will not be emitted if the dataChanged() signal was previously emitted for these changes.

QString QOrganizerManager::managerName () const

Returns the manager name for this QOrganizerManager

QMap<QString, QString> QOrganizerManager::managerParameters () const

Return the parameters relevant to the creation of this QOrganizerManager

QString QOrganizerManager::managerUri () const

Return the uri describing this QOrganizerManager, consisting of the manager name and any parameters.

int QOrganizerManager::managerVersion () const

Returns the engine backend implementation version number

bool QOrganizerManager::parseUri ( const QString & uri, QString * pManagerId, QMap<QString, QString> * pParams ) [static]

Splits the given uri into the manager, store, and parameters that it describes, and places the information into the memory addressed by pManagerId and pParams respectively. Returns true if uri could be split successfully, otherwise returns false

bool QOrganizerManager::removeCollection ( const QOrganizerCollectionId & collectionId )

Removes the collection identified by the given collectionId (and all items in the collection) from the manager if the given collectionId exists. Returns true on success, false on failure.

Attempting to remove the default collection will fail and calling error() will return QOrganizerManager::PermissionsError.

bool QOrganizerManager::removeDetailDefinition ( const QString & definitionName, const QString & organizeritemType )

Removes the detail definition identified by definitionName from the database, which is valid for organizer items whose type is the given organizeritemType. Returns true if the definition was removed successfully, otherwise returns false

bool QOrganizerManager::removeItem ( const QOrganizerItemId & organizeritemId )

Remove the organizer item identified by organizeritemId from the database. Returns true if the organizer item was removed successfully, otherwise returns false.

bool QOrganizerManager::removeItems ( const QList<QOrganizerItemId> & organizeritemIds )

Remove every organizer item whose id is contained in the list of organizer item ids organizeritemIds. Returns true if all organizer items were removed successfully, otherwise false.

Calling errorMap() will return the per-input errors for the latest batch function. The QOrganizerManager::error() function will only return QOrganizerManager::NoError if all organizer items were removed successfully.

If the given list of organizer item ids organizeritemIds is empty, the function will return false and calling error() will return QOrganizerManager::BadArgumentError. If the list is non-empty and contains ids which do not identify a valid organizer item in the manager, the function will remove any organizer items which are identified by ids in the organizeritemIds list, insert QOrganizerManager::DoesNotExist entries into the error map for the indices of invalid ids in the organizeritemIds list, return false, and set the overall operation error to QOrganizerManager::DoesNotExistError.

See also QOrganizerManager::removeItem().

bool QOrganizerManager::saveCollection ( QOrganizerCollection * collection )

Saves the given collection in the manager. Returns true on success, false on failure.

Some managers do not allow modifications to collections, and thus attempting to save a collection will always fail when attempted in such a manager.

Some managers do not allow adding new collections, and thus attempting to save a new collection will always fail when attempted in such a manager.

Some managers provide front-ends to read-only datastores, and attempting to save a new collection in such a manager will always fail.

Most managers will require a valid value for the QOrganizerCollection::KeyName meta data key to be set in a collection, before the collection can be saved correctly. Clients can call compatibleCollection() to retrieve a pruned or updated version of the collection which is compatible with the manager.

See also compatibleCollection().

bool QOrganizerManager::saveDetailDefinition ( const QOrganizerItemDetailDefinition & def, const QString & organizeritemType )

Persists the given definition def in the database, which is valid for organizer items whose type is the given organizeritemType. Returns true if the definition was saved successfully, otherwise returns false

bool QOrganizerManager::saveItem ( QOrganizerItem * item )

Adds the given item to the database if item has a default-constructed id, or an id with the manager URI set to the URI of this manager and a id of zero. It will be saved in the collection whose id is reported by calling item->collectionId() if the specified collection exists, or if no collectionId is specified in the item, or the collectionId is the default collection id, it will be saved in the collection in which the item is currently saved (if it is not a new item) or in the default collection (if it is a new item). As such, an item may be moved between collections with this save operation.

If the manager URI of the id of the item is neither empty nor equal to the URI of this manager, or id of the item is non-zero but does not exist in the manager, the operation will fail and calling error() will return QOrganizerManager::DoesNotExistError.

Alternatively, the function will update the existing organizer item in the database if item has a non-zero id and currently exists in the database.

If the item contains one or more details whose definitions have not yet been saved with the manager, the operation will fail and calling error() will return QOrganizerManager::UnsupportedError.

Returns false on failure, or true on success. On successful save of an organizer item with a null id, its id will be set to a new, valid id with the manager URI set to the URI of this manager, and the id set to a new, valid id. On successful save of an organizer item with a null collection id, the collection id will be set to the id of the default collection of the manager. The manager is not required to fetch updated details of the organizer item on save, and as such, clients should fetch an organizer item if they want the most up-to-date information by calling QOrganizerManager::item().

See also managerUri().

bool QOrganizerManager::saveItems ( QList<QOrganizerItem> * items )

Adds the list of organizer items given by items list to the database. Each item in the list will be saved in the collection whose id is reported by calling item->collectionId() if the specified collection exists, or if no collectionId is specified in the item, or the collectionId is the default collection id, it will be saved in the collection in which the item is currently saved (if it is not a new item) or in the default collection (if it is a new item). As such, an item may be moved between collections with this save operation. Returns true if the organizer items were saved successfully, otherwise false.

Calling errorMap() will return the per-input errors for the latest batch function. The QOrganizerManager::error() function will only return QOrganizerManager::NoError if all organizer items were saved successfully.

For each newly saved organizer item that was successful, the id of the organizer item in the items list will be updated with the new value. If a failure occurs when saving a new item, the id will be cleared.

See also QOrganizerManager::saveItem().

QStringList QOrganizerManager::supportedItemTypes () const

Returns the list of organizer item types which are supported by this manager. This is a convenience function, equivalent to retrieving the allowable values for the QOrganizerItemType::FieldType field of the QOrganizerItemType definition which is valid in this manager.