summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/core/opimaccesstemplate.h
Side-by-side diff
Diffstat (limited to 'libopie2/opiepim/core/opimaccesstemplate.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiepim/core/opimaccesstemplate.h27
1 files changed, 21 insertions, 6 deletions
diff --git a/libopie2/opiepim/core/opimaccesstemplate.h b/libopie2/opiepim/core/opimaccesstemplate.h
index 3e1f393..50cb1e4 100644
--- a/libopie2/opiepim/core/opimaccesstemplate.h
+++ b/libopie2/opiepim/core/opimaccesstemplate.h
@@ -39,4 +39,7 @@ public:
- /**
- * 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.
*/
@@ -44,4 +47,5 @@ public:
- /**
- * 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
*/
@@ -51,2 +55,4 @@ public:
* 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 ?
*/
@@ -61,3 +67,3 @@ public:
/**
- * queryByExample)
+ * queryByExample.
* @see otodoaccess, ocontactaccess
@@ -85,2 +91,4 @@ public:
* add T to the backend
+ * @param t The item to add.
+ * @return <i>true</i> if added successfully.
*/
@@ -91,2 +99,4 @@ public:
* remove T from the backend
+ * @param t The item to remove
+ * @return <i>true</i> if successful.
*/
@@ -96,2 +106,4 @@ public:
* remove the OPimRecord with uid
+ * @param uid The ID of the item to remove
+ * @return <i>true</i> if successful.
*/
@@ -101,2 +113,4 @@ public:
* replace T from backend
+ * @param t The item to replace
+ * @return <i>true</i> if successful.
*/
@@ -144,3 +158,4 @@ template <class T>
bool OPimAccessTemplate<T>::reload() {
- return m_backEnd->reload();
+ invalidateCache(); // zecke: I think this should be added (se)
+ return m_backEnd->reload();
}