Detailed Description
The QPimDependencyList class manages the dependencies between QPimRecords.
This allows the relationships between certain types of records to be maintained. For example, a QContact may have a QAppointment that represents the birthday or anniversary of that contact. In this case, the QAppointment depends on the QContact. When the QContact is removed, the QAppointments will be removed as well.
Currently there are three types of dependencies defined:
- "birthday" - the parent record is a QContact, and the dependent record is the QAppointment representing that contact's birthday
- "anniversary" - the parent record is a QContact, and the dependent record is the QAppointment representing that contact's anniversary
- "duedate" - the parent record is a QTask, and the dependent record is the QAppointment representing that task's due date.
See also Pim Library.
Member Function Documentation
bool QPimDependencyList::addDependency ( const QUniqueId & srcid, const QUniqueId & destid, const QString & deptype ) [static]
Records the dependency of the record given by destid on the parent record srcid, with the given dependency type deptype.
Returns true on success, false otherwise.
QMap<QString, QUniqueId> QPimDependencyList::childrenRecords ( const QUniqueId & recid ) [static]
Returns the dependency type and identifier of any records that are a dependant of the record with the given recid
See also typedChildrenRecords().
QString QPimDependencyList::parentDependencyType ( const QUniqueId & recid ) [static]
If the record identified by recid has a parent dependency, returns the type of the dependency. Otherwise returns a null string.
See also parentRecord().
QUniqueId QPimDependencyList::parentRecord ( const QUniqueId & recid ) [static]
If the record identified by recid has a parent dependency, returns the identifier for that parent. Otherwise returns a null identifier.
See also parentDependencyType().
bool QPimDependencyList::removeDependency ( const QUniqueId & srcid, const QUniqueId & destid, const QString & deptype ) [static]
Removes the dependency from the record destid to the record srcid, with the specified dependency type deptype.
Returns true on success, false otherwise.
QList<QUniqueId> QPimDependencyList::typedChildrenRecords ( const QUniqueId & recid, const QString & deptype ) [static]
Returns the identifiers of any records that are a dependant of the record with the given recid, and have the given deptype of dependency.
See also childrenRecords().
bool QPimDependencyList::updateDependency ( const QUniqueId & srcid, const QUniqueId & destid, const QString & deptype ) [static]
Updates the target of the dependency from the given srcid and type deptype to the new destination destid.
Returns true on success, false otherwise.
