GCW::Dbo::Splits Namespace Reference

Classes
class	Item
	Split Item Class. More...

Functions
auto	load (const std::string &_splitGuid) -> Item::Ptr
	Load a single split.
auto	find (const std::string &_splitGuid) -> Item::Ptr
	Find a single split.
auto	add (const std::string &_splitGuid) -> Item::Ptr
	Add a single split.
auto	byGuid (const std::string &_splitGuid) -> Item::Ptr
	Load a single split.
auto	byAccount (const std::string &_accountGuid) -> Item::Vector
	Load Splits by Account.
auto	bySplitExcept (const std::string &_splitGuid) -> Item::Vector
	Load Splits by Split.
auto	byTransaction (const std::string &_txGuid) -> Item::Vector
	Load Splits by Transaction.

Variables
const char *	s_tableName = "splits"

Function Documentation

add()

auto GCW::Dbo::Splits::add

(

const std::string &

_splitGuid

)

-> Item::Ptr

Add a single split.

This adds a new split item containing the guid requested

Definition at line 153 of file Splits.cpp.

References GCW::app().

Referenced by GCW::Eng::Transaction::Manager::newTransaction().

byAccount()

auto GCW::Dbo::Splits::byAccount

(

const std::string &

_accountGuid

)

-> Item::Vector

Load Splits by Account.

This function returns a vector of Split items, sorted by transaction date. The result includes ~all~ splits associated with a single account.

Returns

Vector of Items sorted by Transction Date

Definition at line 164 of file Splits.cpp.

References GCW::app().

Referenced by GCW::Gui::BillPay::PaymentWidget::lastTx(), and GCW::Gui::AccountRegister::Model::refreshFromDisk().

byGuid()

auto GCW::Dbo::Splits::byGuid ( const std::string &  _splitGuid ) -> Item::Ptr

inline

Load a single split.

This function returns a split based on the GUID.

Definition at line 331 of file Splits.h.

References load().

Referenced by GCW::Gui::AccountRegister::Model::isDeletable().

bySplitExcept()

auto GCW::Dbo::Splits::bySplitExcept

(

const std::string &

_splitGuid

)

-> Item::Vector

Load Splits by Split.

This function returns a vector of Split items, sorted by transaction date. The result includes ~all~ splits associated with a transaction except for the split ID used to identify the transaction. This function acts as a convenience function for a split to quickly identify all of the 'other' splits in the transaction.

Returns

Vector of Items sorted by Transction Date

Definition at line 201 of file Splits.cpp.

References GCW::app(), and load().

Referenced by GCW::Eng::Transaction::Manager::otherSplits().

byTransaction()

auto GCW::Dbo::Splits::byTransaction

(

const std::string &

_txGuid

)

-> Item::Vector

Load Splits by Transaction.

This function returns a vector of Split items, sorted by transaction date. The result includes ~all~ splits associated with a transaction

Returns

Vector of Items sorted by Transction Date

Definition at line 243 of file Splits.cpp.

References GCW::app().

Referenced by GCW::Gui::BillPay::PaymentWidget::lastSplit(), GCW::Eng::Transaction::Manager::loadTransaction(), and GCW::Gui::BillPay::SummaryWidget::Splits::Splits().

find()

auto GCW::Dbo::Splits::find

(

const std::string &

_splitGuid

)

-> Item::Ptr

Find a single split.

This function returns a split based on the GUID. If the split is not found, a simple empty object is returned.

Definition at line 121 of file Splits.cpp.

References GCW::app().

load()

auto GCW::Dbo::Splits::load

(

const std::string &

_splitGuid

)

-> Item::Ptr

Load a single split.

This function returns a split based on the GUID.

Definition at line 102 of file Splits.cpp.

References GCW::app().

Referenced by byGuid(), bySplitExcept(), and GCW::Eng::Transaction::Manager::loadSplit().

Variable Documentation

s_tableName

const char * GCW::Dbo::Splits::s_tableName = "splits"

extern

Definition at line 8 of file Splits.cpp.