Moved Store to separate file

1 files changed, 101 insertions, 0 deletions

diff --git a/common/store.h b/common/store.h
new file mode 100644
index 0000000..6696833
--- /dev/null
+++ b/common/store.h
@@ -0,0 +1,101 @@
+/*
+ * Copyright (C) 2015 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 "sink_export.h"
+#include <QString>
+#include <QSharedPointer>
+
+#include <Async/Async>
+
+#include "query.h"
+#include "applicationdomaintype.h"
+
+class QAbstractItemModel;
+
+namespace Sink {
+
+/**
+ * The unified Sink Store.
+ * 
+ * This is the primary interface for clients to interact with Sink.
+ * It provides a unified store where all data provided by various resources can be accessed and modified.
+ */
+namespace Store {
+
+QString SINK_EXPORT storageLocation();
+
+enum Roles {
+    DomainObjectRole = Qt::UserRole + 1, //Must be the same as in ModelResult
+    ChildrenFetchedRole,
+    DomainObjectBaseRole
+};
+
+/**
+    * Asynchronusly load a dataset with tree structure information
+    */
+template <class DomainType>
+QSharedPointer<QAbstractItemModel> SINK_EXPORT loadModel(Query query);
+
+/**
+ * Create a new entity.
+ */
+template <class DomainType>
+KAsync::Job<void> SINK_EXPORT create(const DomainType &domainObject);
+
+/**
+ * Modify an entity.
+ * 
+ * This includes moving etc. since these are also simple settings on a property.
+ */
+template <class DomainType>
+KAsync::Job<void> SINK_EXPORT modify(const DomainType &domainObject);
+
+/**
+ * Remove an entity.
+ */
+template <class DomainType>
+KAsync::Job<void> SINK_EXPORT remove(const DomainType &domainObject);
+
+/**
+ * Synchronize data to local cache.
+ */
+KAsync::Job<void> SINK_EXPORT synchronize(const Sink::Query &query);
+
+/**
+ * Removes all resource data from disk.
+ * 
+ * This will not touch the configuration. All commands that that arrived at the resource before this command will be dropped. All commands that arrived later will be executed.
+ */
+KAsync::Job<void> SINK_EXPORT removeDataFromDisk(const QByteArray &resourceIdentifier);
+
+template <class DomainType>
+KAsync::Job<DomainType> SINK_EXPORT fetchOne(const Sink::Query &query);
+
+template <class DomainType>
+KAsync::Job<QList<typename DomainType::Ptr> > SINK_EXPORT fetchAll(const Sink::Query &query);
+
+template <class DomainType>
+KAsync::Job<QList<typename DomainType::Ptr> > SINK_EXPORT fetch(const Sink::Query &query, int minimumAmount = 0);
+
+    }
+}
+