1 files changed, 51 insertions, 0 deletions

diff --git a/common/facadeinterface.h b/common/facadeinterface.h
new file mode 100644
index 0000000..a88c104
--- /dev/null
+++ b/common/facadeinterface.h
@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) version 3, or any
+ * later version accepted by the membership of KDE e.V. (or its
+ * successor approved by the membership of KDE e.V.), which shall
+ * act as a proxy defined in Section 6 of version 3 of the license.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <Async/Async>
+#include <QByteArray>
+#include <QSharedPointer>
+#include "domain/applicationdomaintype.h"
+#include "resultprovider.h"
+
+namespace Akonadi2 {
+class Query;
+
+/**
+ * Interface for the store facade.
+ * 
+ * All methods are synchronous.
+ * Facades are stateful (they hold connections to resources and database).
+ * 
+ * TODO: would it make sense to split the write, read and notification parts? (we could potentially save some connections)
+ */
+template<class DomainType>
+class StoreFacade {
+public:
+    virtual ~StoreFacade(){};
+    QByteArray type() const { return ApplicationDomain::getTypeName<DomainType>(); }
+    virtual KAsync::Job<void> create(const DomainType &domainObject) = 0;
+    virtual KAsync::Job<void> modify(const DomainType &domainObject) = 0;
+    virtual KAsync::Job<void> remove(const DomainType &domainObject) = 0;
+    virtual KAsync::Job<void> load(const Query &query, const QSharedPointer<async::ResultProvider<typename DomainType::Ptr> > &resultProvider) = 0;
+};
+
+}