ui/include/ui/workspace/WorkspaceCommands.h

Go to the documentation of this file.

 
#pragma once
 
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariant>
#include <QVariantMap>
 
#include <functional>
#include <optional>
 
#include "core/ports/workspace/WorkspaceSnapshot.h"
#include "ui/workspace/WorkspaceStore.h"
 
namespace ui {

class WorkspaceCommands : public QObject {
  Q_OBJECT
 
public:
  explicit WorkspaceCommands(WorkspaceStore& store, QObject* parent = nullptr);

  std::optional<core::ports::workspace::StatementDraftSnapshot>
  statementDraftSnapshot(const QString& draftId = {}) const;
  QString finalizeStatementDraft(
      const core::ports::workspace::StatementDraftSnapshot& draft);
  void saveStatementDraft(
      const core::ports::workspace::StatementDraftSnapshot& draft);
  void clearStatementDraft(const QString& draftId = {});

  void upsertImportLog(const QString& logId, const QString& status,
                       const QString& message, bool draftAttached,
                       const QString& draftId = {},
                       const QString& statementId = {},
                       const QString& importFile = {});
  void deleteImportLog(const QString& id);

  void saveExportLog(const core::ports::workspace::ExportLogSnapshot& log);
  void deleteExportLog(const QString& id);

  void newFile(const QString& path);
  void openFile(const QString& path);
  void saveFile();
  void saveFileAs(const QString& path);
  void setBeforeStorageSaveCallback(std::function<void()> callback);

  QString saveActor(const QString& id, const QString& name,
                    const QStringList& aliases = {},
                    const QStringList& contractIds = {});
  void deleteActor(const QString& id);

  QString saveProperty(const QString& id, const QString& name,
                       const QStringList& aliases = {},
                       const QStringList& contractIds = {});
  void deleteProperty(const QString& id);

  QString
  saveContract(const QString& id, const QString& name, const QString& type,
               const QStringList& actorIds = {},
               const QStringList& propertyIds = {},
               const QStringList& aliases = {},
               const QString& allocatableMode = QStringLiteral("mixed"));
  void deleteContract(const QString& id);

  QString addStatement(const QString& name);
  QString addStatementWithTransactions(const QString& name,
                                       const QVariantList& transactionStates);
  void updateStatement(const QString& id, const QString& name);
  void deleteStatement(const QString& id);

  QString addTransaction(const QString& name, const QString& bookingDate,
                         const QString& valuta, const QVariant& amount,
                         const QString& statementId, int status = 0,
                         const QString& actorId = QString(),
                         const QString& contractId = QString(),
                         bool allocatable = false,
                         const QStringList& propertyIds = {});
  QString insertTransactionAfter(
      const QString& afterTransactionId, const QString& name,
      const QString& bookingDate, const QString& valuta, const QVariant& amount,
      const QString& statementId, int status = 0,
      const QString& actorId = QString(), const QString& contractId = QString(),
      bool allocatable = false, const QStringList& propertyIds = {});
  void updateTransaction(const QString& id, const QString& name,
                         const QString& bookingDate, const QString& valuta,
                         const QVariant& amount, const QString& statementId,
                         int status, const QString& actorId,
                         const QString& contractId, bool allocatable,
                         const QStringList& propertyIds);
  void deleteTransaction(const QString& id);

  QString addAnalysis(const QString& name, const QString& type,
                      const QVariantMap& config, const QVariantMap& filter,
                      const QString& exportFormat, bool includeCalcAdjustments,
                      const QVariantList& snapshotTransactions,
                      const QVariantMap& adjustments = {});
  void updateAnalysis(const QString& id, const QString& name,
                      const QString& type, const QVariantMap& config,
                      const QVariantMap& filter, const QString& exportFormat,
                      bool includeCalcAdjustments,
                      const QVariantList& snapshotTransactions,
                      const QVariantMap& adjustments = {});
  void deleteAnalysis(const QString& id);
  void updateAnalysisExportFormat(const QString& analysisId,
                                  const QString& exportFormat);

  QString addAnnual(const QString& name, int year,
                    const QStringList& analysisIds = {});
  void updateAnnual(const QString& id, const QString& name, int year,
                    const QStringList& analysisIds = {});
  void deleteAnnual(const QString& id);
 
signals:
  void operationSucceeded(const QString& operation);
  void operationFailed(const QString& operation, const QString& error);
 
private:
  QVariantMap validateActor(const QString& id, const QString& name,
                            const QStringList& aliases = {},
                            const QStringList& contractIds = {}) const;
  QVariantMap validateProperty(const QString& id, const QString& name,
                               const QStringList& aliases = {},
                               const QStringList& contractIds = {}) const;
  QVariantMap validateContract(
      const QString& id, const QString& name, const QString& type,
      const QStringList& actorIds = {}, const QStringList& propertyIds = {},
      const QStringList& aliases = {},
      const QString& allocatableMode = QStringLiteral("mixed")) const;
  QVariantMap validateStatement(const QString& id, const QString& name) const;
  QVariantMap validateTransaction(const QString& id, const QString& name,
                                  const QString& bookingDate,
                                  const QString& valuta, const QVariant& amount,
                                  const QString& statementId, int status,
                                  const QString& actorId,
                                  const QString& contractId, bool allocatable,
                                  const QStringList& propertyIds) const;
  QVariantMap validateAnnual(const QString& id, const QString& name, int year,
                             const QStringList& analysisIds = {}) const;
  void refreshStoreFromReader();
  void runStorageOperation(const QString& operation,
                           const std::function<void()>& action);
  void saveImportLog(const core::ports::workspace::ImportLogSnapshot& log);
  bool rejectInvalidCommand(
      const char* origin,
      const core::ports::workspace::ValidationResult& result) const;
 
  WorkspaceStore& store_;
  std::function<void()> beforeStorageSave_;
};
 
} // namespace ui