Diffstat (limited to 'libopie/pim/opimaccesstemplate.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libopie/pim/opimaccesstemplate.h | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/libopie/pim/opimaccesstemplate.h b/libopie/pim/opimaccesstemplate.h index 3e1f393..50cb1e4 100644 --- a/libopie/pim/opimaccesstemplate.h +++ b/libopie/pim/opimaccesstemplate.h @@ -36,20 +36,26 @@ public: * load from the backend */ virtual bool load(); - /** - * reload from the backend + /** Reload database. + * You should execute this function if the external database + * was changed. + * This function will load the external database and afterwards + * rejoin the local changes. Therefore the local database will be set consistent. */ virtual bool reload(); - /** - * save to the backend + /** Save contacts database. + * Save is more a "commit". After calling this function, all changes are public available. + * @return true if successful */ virtual bool save(); /** * if the resource was changed externally + * You should use the signal handling instead of polling possible changes ! + * zecke: Do you implement a signal for otodoaccess ? */ bool wasChangedExternally()const; /** @@ -58,9 +64,9 @@ public: */ virtual List allRecords()const; /** - * queryByExample) + * queryByExample. * @see otodoaccess, ocontactaccess */ virtual List queryByExample( const T& t, int querySettings ); @@ -82,24 +88,32 @@ public: virtual void clear() ; /** * add T to the backend + * @param t The item to add. + * @return <i>true</i> if added successfully. */ virtual bool add( const T& t ) ; /* only the uid matters */ /** * remove T from the backend + * @param t The item to remove + * @return <i>true</i> if successful. */ virtual bool remove( const T& t ); /** * remove the OPimRecord with uid + * @param uid The ID of the item to remove + * @return <i>true</i> if successful. */ virtual bool remove( int uid ); /** * replace T from backend + * @param t The item to replace + * @return <i>true</i> if successful. */ virtual bool replace( const T& t) ; /** @@ -141,9 +155,10 @@ bool OPimAccessTemplate<T>::load() { return m_backEnd->load(); } template <class T> bool OPimAccessTemplate<T>::reload() { - return m_backEnd->reload(); + invalidateCache(); // zecke: I think this should be added (se) + return m_backEnd->reload(); } template <class T> bool OPimAccessTemplate<T>::save() { return m_backEnd->save(); |