KDE PIM / Developers / API Docs / ksync

KSyncEntry Class Reference

An entry of a dataset which is to be synced. More...

#include <ksyncer.h>

Inherited by AddressBookSyncEntry, BookmarkSyncEntry, and CalendarSyncEntry.

List of all members.

Public Member Functions


Detailed Description

An entry of a dataset which is to be synced.

Author:
Cornelius Schumacher
See also:
Ksyncee, KSyncer
The KSyncEntry class represents the basic unit of syncing. It provides an interface for identifying and comparing entries, which has to be implemented by concrete subclasses.

KSyncEntry objects are collected by KSyncee objects.


Member Function Documentation

virtual QString KSyncEntry::name  )  [pure virtual]
 

Return a string describing this entry.

This is presented to the user as identifier for the entry, when user interaction is required.

virtual QString KSyncEntry::id  )  [pure virtual]
 

Return a unique id.

This is used to uniquely identify the entry. Two entries having the same id are considered to be two variants of the same entry. No two entries of the same KSyncee data set must have the same id.

virtual QString KSyncEntry::timestamp  )  [pure virtual]
 

Return a time stamp representing the time of the last change.

This is only used to compare, if an entry has changed or not. It is not used to define an order of changes. If an entry has been copied from one KSyncee data set to another KSyncee data set, the timestamp has to be the same on both entries. If the user has changed the entry in one data set the timestamp has to be different.

Return QString::null, if there is no timestamp available. This means that the user has to manually select which entry is the new one.

virtual bool KSyncEntry::equals KSyncEntry  )  [pure virtual]
 

Return, if the two entries are equal.

Two entries are considered to be equal, if they contain exactly the same information, including the same id and timestamp.

void KSyncEntry::setSyncee KSyncee  ) 
 

Set the KSyncee data set, the entry belongs to.

KSyncee * KSyncEntry::syncee  ) 
 

Return the KSyncee data set, the entry belongs to.


The documentation for this class was generated from the following files: