Maps UI intent to core workspace writer commands. More...

#include <WorkspaceCommands.h>

Inheritance diagram for ui::WorkspaceCommands:

Collaboration diagram for ui::WorkspaceCommands:

Signals
void	operationSucceeded (const QString &operation)
	Emitted when a storage command completed.
void	operationFailed (const QString &operation, const QString &error)
	Emitted when a storage command failed.

Public Member Functions
	WorkspaceCommands (WorkspaceStore &store, QObject *parent=nullptr)
	Creates workspace commands for a store.
std::optional< core::ports::workspace::StatementDraftSnapshot >	statementDraftSnapshot (const QString &draftId={}) const
	Reads a statement draft snapshot from workspace state.
QString	finalizeStatementDraft (const core::ports::workspace::StatementDraftSnapshot &draft)
	Finalizes a statement draft through the workspace writer.
void	saveStatementDraft (const core::ports::workspace::StatementDraftSnapshot &draft)
	Saves a statement draft in workspace state.
void	clearStatementDraft (const QString &draftId={})
	Removes a statement draft from workspace state.
void	upsertImportLog (const QString &logId, const QString &status, const QString &message, bool draftAttached, const QString &draftId={}, const QString &statementId={}, const QString &importFile={})
	Creates or updates an import log row.
void	deleteImportLog (const QString &id)
	Deletes an import log.
void	saveExportLog (const core::ports::workspace::ExportLogSnapshot &log)
	Saves an export log in workspace state.
void	deleteExportLog (const QString &id)
	Deletes an export log.
void	newFile (const QString &path)
	Creates a new workspace file.
void	openFile (const QString &path)
	Opens an existing workspace file.
void	saveFile ()
	Saves the current workspace file.
void	saveFileAs (const QString &path)
	Saves the current workspace file to a new path.
void	setBeforeStorageSaveCallback (std::function< void()> callback)
	Registers an optional hook executed immediately before storage save.
QString	saveActor (const QString &id, const QString &name, const QStringList &aliases={}, const QStringList &contractIds={})
	Creates or updates an actor.
void	deleteActor (const QString &id)
	Deletes an actor.
QString	saveProperty (const QString &id, const QString &name, const QStringList &aliases={}, const QStringList &contractIds={})
	Creates or updates a property.
void	deleteProperty (const QString &id)
	Deletes a property.
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"))
	Creates or updates a contract.
void	deleteContract (const QString &id)
	Deletes a contract.
QString	addStatement (const QString &name)
	Creates a statement.
QString	addStatementWithTransactions (const QString &name, const QVariantList &transactionStates)
	Creates a statement and its transactions in one workspace mutation.
void	updateStatement (const QString &id, const QString &name)
	Updates a statement.
void	deleteStatement (const QString &id)
	Deletes a statement.
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={})
	Creates a transaction.
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={})
	Creates a transaction after another transaction.
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)
	Updates a transaction.
void	deleteTransaction (const QString &id)
	Deletes a transaction.
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={})
	Creates an analysis.
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={})
	Updates an analysis.
void	deleteAnalysis (const QString &id)
	Deletes an analysis.
void	updateAnalysisExportFormat (const QString &analysisId, const QString &exportFormat)
	Updates only the stored export format of an analysis.
QString	addAnnual (const QString &name, int year, const QStringList &analysisIds={})
	Creates an annual.
void	updateAnnual (const QString &id, const QString &name, int year, const QStringList &analysisIds={})
	Updates an annual.
void	deleteAnnual (const QString &id)
	Deletes an annual.

Detailed Description

Maps UI intent to core workspace writer commands.

Definition at line 25 of file ui/include/ui/workspace/WorkspaceCommands.h.

Constructor & Destructor Documentation

◆ WorkspaceCommands()

ui::WorkspaceCommands::WorkspaceCommands	(	WorkspaceStore &	store,
		QObject *	parent = nullptr )

explicit

Creates workspace commands for a store.

Parameters

store	Workspace store owning ports and snapshot refresh state.
parent	Optional Qt parent.

Definition at line 241 of file WorkspaceCommands.cpp.

Member Function Documentation

◆ addAnalysis()

QString ui::WorkspaceCommands::addAnalysis	(	const QString &	name,
		const QString &	type,
		const QVariantMap &	config,
		const QVariantMap &	filter,
		const QString &	exportFormat,
		bool	includeCalcAdjustments,
		const QVariantList &	snapshotTransactions,
		const QVariantMap &	adjustments = {} )

Creates an analysis.

Parameters

name	Analysis name.
type	Analysis type.
config	Analysis configuration payload.
filter	Analysis filter payload.
exportFormat	Export format.
includeCalcAdjustments	Whether calculation adjustments are included.
snapshotTransactions	Frozen transaction snapshot rows.
adjustments	Adjustment amount map.

Returns: Created analysis id or an empty string.

Definition at line 704 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAnnual()

QString ui::WorkspaceCommands::addAnnual	(	const QString &	name,
		int	year,
		const QStringList &	analysisIds = {} )

Creates an annual.

Parameters

name	Annual name.
year	Annual year.
analysisIds	Assigned analysis ids.

Returns: Created annual id or an empty string.

Definition at line 794 of file WorkspaceCommands.cpp.

◆ addStatement()

QString ui::WorkspaceCommands::addStatement ( const QString & name )

Creates a statement.

Parameters

name	Statement name.

Returns: Created statement id or an empty string.

Definition at line 562 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ addStatementWithTransactions()

QString ui::WorkspaceCommands::addStatementWithTransactions	(	const QString &	name,
		const QVariantList &	transactionStates )

Creates a statement and its transactions in one workspace mutation.

Parameters

name	Statement name.
transactionStates	Transaction form state rows.

Returns: Created statement id or an empty string.

Definition at line 578 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ addTransaction()

QString ui::WorkspaceCommands::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 = {} )

Creates a transaction.

Parameters

name	Transaction name.
bookingDate	Booking date text.
valuta	Valuta date text.
amount	Raw UI amount value.
statementId	Owning statement id.
status	Transaction status.
actorId	Linked actor id.
contractId	Linked contract id.
allocatable	Allocatable flag.
propertyIds	Linked property ids.

Returns: Created transaction id or an empty string.

Definition at line 636 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearStatementDraft()

void ui::WorkspaceCommands::clearStatementDraft ( const QString & draftId = {} )

Removes a statement draft from workspace state.

Parameters

draftId Draft id; empty allows the writer default.

Definition at line 317 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ deleteActor()

void ui::WorkspaceCommands::deleteActor ( const QString & id )

Deletes an actor.

Parameters

id Actor id.

Definition at line 466 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAnalysis()

void ui::WorkspaceCommands::deleteAnalysis ( const QString & id )

Deletes an analysis.

Parameters

id	Analysis id.

Definition at line 747 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAnnual()

void ui::WorkspaceCommands::deleteAnnual ( const QString & id )

Deletes an annual.

Parameters

id	Annual id.

Definition at line 823 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ deleteContract()

void ui::WorkspaceCommands::deleteContract ( const QString & id )

Deletes a contract.

Parameters

id	Contract id.

Definition at line 545 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteExportLog()

void ui::WorkspaceCommands::deleteExportLog ( const QString & id )

Deletes an export log.

Parameters

id	Export log id.

Definition at line 396 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ deleteImportLog()

void ui::WorkspaceCommands::deleteImportLog ( const QString & id )

Deletes an import log.

Parameters

id	Import log id.

Definition at line 378 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ deleteProperty()

void ui::WorkspaceCommands::deleteProperty ( const QString & id )

Deletes a property.

Parameters

id	Property id.

Definition at line 503 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ deleteStatement()

void ui::WorkspaceCommands::deleteStatement ( const QString & id )

Deletes a statement.

Parameters

id	Statement id.

Definition at line 616 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ deleteTransaction()

void ui::WorkspaceCommands::deleteTransaction ( const QString & id )

Deletes a transaction.

Parameters

id	Transaction id.

Definition at line 697 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finalizeStatementDraft()

QString ui::WorkspaceCommands::finalizeStatementDraft ( const core::ports::workspace::StatementDraftSnapshot & draft )

Finalizes a statement draft through the workspace writer.

Parameters

draft Draft snapshot to finalize.

Returns: Created statement id or an empty string.

Definition at line 293 of file WorkspaceCommands.cpp.

◆ insertTransactionAfter()

QString ui::WorkspaceCommands::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 = {} )

Creates a transaction after another transaction.

Parameters

afterTransactionId	Transaction id used as insertion anchor.
name	Transaction name.
bookingDate	Booking date text.
valuta	Valuta date text.
amount	Raw UI amount value.
statementId	Owning statement id.
status	Transaction status.
actorId	Linked actor id.
contractId	Linked contract id.
allocatable	Allocatable flag.
propertyIds	Linked property ids.

Returns: Created transaction id or an empty string.

Definition at line 657 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newFile()

void ui::WorkspaceCommands::newFile ( const QString & path )

Creates a new workspace file.

Parameters

path	Target file path.

Definition at line 403 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openFile()

void ui::WorkspaceCommands::openFile ( const QString & path )

Opens an existing workspace file.

Parameters

path	Source file path.

Definition at line 409 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operationFailed

void ui::WorkspaceCommands::operationFailed	(	const QString &	operation,
		const QString &	error )

signal

Emitted when a storage command failed.

Parameters

operation	Storage operation name.
error	Error message.

Here is the caller graph for this function:

◆ operationSucceeded

void ui::WorkspaceCommands::operationSucceeded ( const QString & operation )

signal

Emitted when a storage command completed.

Parameters

operation Storage operation name.

Here is the caller graph for this function:

◆ saveActor()

QString ui::WorkspaceCommands::saveActor	(	const QString &	id,
		const QString &	name,
		const QStringList &	aliases = {},
		const QStringList &	contractIds = {} )

Creates or updates an actor.

Parameters

id	Existing actor id or empty to create.
name	Actor name.
aliases	Actor aliases.
contractIds	Linked contract ids.

Returns: Saved actor id or an empty string.

Definition at line 448 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveContract()

QString ui::WorkspaceCommands::saveContract	(	const QString &	id,
		const QString &	name,
		const QString &	type,
		const QStringList &	actorIds = {},
		const QStringList &	propertyIds = {},
		const QStringList &	aliases = {},
		const QString &	allocatableMode = QStringLiteral("mixed") )

Creates or updates a contract.

Parameters

id	Existing contract id or empty to create.
name	Contract name.
type	Contract type.
actorIds	Linked actor ids.
propertyIds	Linked property ids.
aliases	Contract aliases.
allocatableMode	Contract allocatable mode.

Returns: Saved contract id or an empty string.

Definition at line 522 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveExportLog()

void ui::WorkspaceCommands::saveExportLog ( const core::ports::workspace::ExportLogSnapshot & log )

Saves an export log in workspace state.

Parameters

log	Export log snapshot.

Definition at line 385 of file WorkspaceCommands.cpp.

◆ saveFile()

void ui::WorkspaceCommands::saveFile ( )

Saves the current workspace file.

Definition at line 415 of file WorkspaceCommands.cpp.

Here is the caller graph for this function:

◆ saveFileAs()

void ui::WorkspaceCommands::saveFileAs ( const QString & path )

Saves the current workspace file to a new path.

Parameters

path	Target file path.

Definition at line 424 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveProperty()

QString ui::WorkspaceCommands::saveProperty	(	const QString &	id,
		const QString &	name,
		const QStringList &	aliases = {},
		const QStringList &	contractIds = {} )

Creates or updates a property.

Parameters

id	Existing property id or empty to create.
name	Property name.
aliases	Property aliases.
contractIds	Linked contract ids.

Returns: Saved property id or an empty string.

Definition at line 484 of file WorkspaceCommands.cpp.

◆ saveStatementDraft()

void ui::WorkspaceCommands::saveStatementDraft ( const core::ports::workspace::StatementDraftSnapshot & draft )

Saves a statement draft in workspace state.

Parameters

draft Draft snapshot to save.

Definition at line 306 of file WorkspaceCommands.cpp.

◆ setBeforeStorageSaveCallback()

void ui::WorkspaceCommands::setBeforeStorageSaveCallback ( std::function< void()> callback )

Registers an optional hook executed immediately before storage save.

Parameters

callback Callback used by composition to flush active workflow state.

Definition at line 433 of file WorkspaceCommands.cpp.

◆ statementDraftSnapshot()

std::optional< core::ports::workspace::StatementDraftSnapshot > ui::WorkspaceCommands::statementDraftSnapshot ( const QString & draftId = {} ) const

Reads a statement draft snapshot from workspace state.

Parameters

draftId Draft id; empty allows the workspace reader default.

Returns: Draft snapshot when available.

Definition at line 287 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ updateAnalysis()

void ui::WorkspaceCommands::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 = {} )

Updates an analysis.

Parameters

id	Analysis id.
name	Analysis name.
type	Analysis type.
config	Analysis configuration payload.
filter	Analysis filter payload.
exportFormat	Export format.
includeCalcAdjustments	Whether calculation adjustments are included.
snapshotTransactions	Frozen transaction snapshot rows.
adjustments	Adjustment amount map.

Definition at line 728 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateAnalysisExportFormat()

void ui::WorkspaceCommands::updateAnalysisExportFormat	(	const QString &	analysisId,
		const QString &	exportFormat )

Updates only the stored export format of an analysis.

Parameters

analysisId	Analysis id.
exportFormat	Export format.

Definition at line 754 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateAnnual()

void ui::WorkspaceCommands::updateAnnual	(	const QString &	id,
		const QString &	name,
		int	year,
		const QStringList &	analysisIds = {} )

Updates an annual.

Parameters

id	Annual id.
name	Annual name.
year	Annual year.
analysisIds	Assigned analysis ids.

Definition at line 810 of file WorkspaceCommands.cpp.

◆ updateStatement()

void ui::WorkspaceCommands::updateStatement	(	const QString &	id,
		const QString &	name )

Updates a statement.

Parameters

id	Statement id.
name	Statement name.

Definition at line 601 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

◆ updateTransaction()

void ui::WorkspaceCommands::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 )

Updates a transaction.

Parameters

id	Transaction id.
name	Transaction name.
bookingDate	Booking date text.
valuta	Valuta date text.
amount	Raw UI amount value.
statementId	Owning statement id.
status	Transaction status.
actorId	Linked actor id.
contractId	Linked contract id.
allocatable	Allocatable flag.
propertyIds	Linked property ids.

Definition at line 679 of file WorkspaceCommands.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ upsertImportLog()

void ui::WorkspaceCommands::upsertImportLog	(	const QString &	logId,
		const QString &	status,
		const QString &	message,
		bool	draftAttached,
		const QString &	draftId = {},
		const QString &	statementId = {},
		const QString &	importFile = {} )

Creates or updates an import log row.

Parameters

logId	Existing log id or empty for a generated id.
status	User-visible import status.
message	User-visible import message.
draftAttached	Whether the log points to a review draft.
draftId	Attached draft id.
statementId	Finalized statement id.
importFile	Source import file.

Definition at line 336 of file WorkspaceCommands.cpp.

The documentation for this class was generated from the following files:

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WorkspaceCommands()

Member Function Documentation

◆ addAnalysis()

◆ addAnnual()

◆ addStatement()

◆ addStatementWithTransactions()

◆ addTransaction()

◆ clearStatementDraft()

◆ deleteActor()

◆ deleteAnalysis()

◆ deleteAnnual()

◆ deleteContract()

◆ deleteExportLog()

◆ deleteImportLog()

◆ deleteProperty()

◆ deleteStatement()

◆ deleteTransaction()

◆ finalizeStatementDraft()

◆ insertTransactionAfter()

◆ newFile()

◆ openFile()

◆ operationFailed

◆ operationSucceeded

◆ saveActor()

◆ saveContract()

◆ saveExportLog()

◆ saveFile()

◆ saveFileAs()

◆ saveProperty()

◆ saveStatementDraft()

◆ setBeforeStorageSaveCallback()

◆ statementDraftSnapshot()

◆ updateAnalysis()

◆ updateAnalysisExportFormat()

◆ updateAnnual()

◆ updateStatement()

◆ updateTransaction()

◆ upsertImportLog()