IMyMoneySerialize Class Reference

#include <imymoneyserialize.h>

Inheritance diagram for IMyMoneySerialize:

MyMoneyDatabaseMgr MyMoneySeqAccessMgr

List of all members.

Public Member Functions

 IMyMoneySerialize ()
virtual ~IMyMoneySerialize ()
virtual const MyMoneyPayee user (void) const =0
virtual const QDate creationDate (void) const =0
virtual const QDate lastModificationDate (void) const =0
virtual unsigned int currentFixVersion (void) const =0
virtual unsigned int fileFixVersion (void) const =0
virtual void setUser (const MyMoneyPayee &val)=0
virtual void setCreationDate (const QDate &val)=0
virtual void setFileFixVersion (const unsigned int v)=0
virtual KSharedPtr
< MyMoneyStorageSql
connectToDatabase (const KURL &url)=0
virtual void fillStorage ()=0
virtual void setLastModificationDate (const QDate &val)=0
virtual void accountList (QValueList< MyMoneyAccount > &list) const =0
virtual const QValueList
< MyMoneyInstitution
institutionList (void) const =0
virtual void transactionList (QValueList< MyMoneyTransaction > &list, MyMoneyTransactionFilter &filter) const =0
virtual bool isDuplicateTransaction (const QString &) const =0
virtual const QValueList
< MyMoneyPayee
payeeList (void) const =0
virtual const QValueList
< MyMoneySchedule
scheduleList (const QString &=QString(), const MyMoneySchedule::typeE=MyMoneySchedule::TYPE_ANY, const MyMoneySchedule::occurenceE=MyMoneySchedule::OCCUR_ANY, const MyMoneySchedule::paymentTypeE=MyMoneySchedule::STYPE_ANY, const QDate &=QDate(), const QDate &=QDate(), const bool=false) const =0
virtual const QValueList
< MyMoneySecurity
securityList (void) const =0
virtual const MyMoneyAccount liability (void) const =0
virtual const MyMoneyAccount asset (void) const =0
virtual const MyMoneyAccount expense (void) const =0
virtual const MyMoneyAccount income (void) const =0
virtual const MyMoneyAccount equity (void) const =0
virtual void addAccount (MyMoneyAccount &account)=0
virtual void addAccount (MyMoneyAccount &parent, MyMoneyAccount &account)=0
virtual void addPayee (MyMoneyPayee &payee)=0
virtual void addInstitution (MyMoneyInstitution &institution)=0
virtual void addTransaction (MyMoneyTransaction &transaction, const bool skipAccountUpdate=false)=0
virtual void loadAccounts (const QMap< QString, MyMoneyAccount > &map)=0
virtual void loadTransactions (const QMap< QString, MyMoneyTransaction > &map)=0
virtual void loadInstitutions (const QMap< QString, MyMoneyInstitution > &map)=0
virtual void loadPayees (const QMap< QString, MyMoneyPayee > &map)=0
virtual void loadSchedules (const QMap< QString, MyMoneySchedule > &map)=0
virtual void loadSecurities (const QMap< QString, MyMoneySecurity > &map)=0
virtual void loadCurrencies (const QMap< QString, MyMoneySecurity > &map)=0
virtual void loadReports (const QMap< QString, MyMoneyReport > &reports)=0
virtual void loadBudgets (const QMap< QString, MyMoneyBudget > &budgets)=0
virtual void loadPrices (const MyMoneyPriceList &list)=0
virtual unsigned long accountId (void) const =0
virtual unsigned long transactionId (void) const =0
virtual unsigned long payeeId (void) const =0
virtual unsigned long institutionId (void) const =0
virtual unsigned long scheduleId (void) const =0
virtual unsigned long securityId (void) const =0
virtual unsigned long reportId (void) const =0
virtual unsigned long budgetId (void) const =0
virtual void loadAccountId (const unsigned long id)=0
virtual void loadTransactionId (const unsigned long id)=0
virtual void loadPayeeId (const unsigned long id)=0
virtual void loadInstitutionId (const unsigned long id)=0
virtual void loadScheduleId (const unsigned long id)=0
virtual void loadSecurityId (const unsigned long id)=0
virtual void loadReportId (const unsigned long id)=0
virtual void loadBudgetId (const unsigned long id)=0
virtual const QMap< QString,
QString > 
pairs (void) const =0
virtual void setPairs (const QMap< QString, QString > &list)=0
virtual const QValueList
< MyMoneySchedule
scheduleListEx (int scheduleTypes, int scheduleOcurrences, int schedulePaymentTypes, QDate startDate, const QStringList &accounts=QStringList()) const =0
virtual const QValueList
< MyMoneySecurity
currencyList (void) const =0
virtual const QValueList
< MyMoneyReport
reportList (void) const =0
virtual const QValueList
< MyMoneyBudget
budgetList (void) const =0
virtual void addPrice (const MyMoneyPrice &price)=0
virtual const MyMoneyPriceList priceList (void) const =0
virtual void rebuildAccountBalances (void)=0


Detailed Description

Author:
Thomas Baumgart This class represents the interface to serialize a MyMoneyStorage object

Constructor & Destructor Documentation

IMyMoneySerialize::IMyMoneySerialize (  ) 

virtual IMyMoneySerialize::~IMyMoneySerialize (  )  [virtual]


Member Function Documentation

virtual const MyMoneyPayee IMyMoneySerialize::user ( void   )  const [pure virtual]

virtual const QDate IMyMoneySerialize::creationDate ( void   )  const [pure virtual]

virtual const QDate IMyMoneySerialize::lastModificationDate ( void   )  const [pure virtual]

virtual unsigned int IMyMoneySerialize::currentFixVersion ( void   )  const [pure virtual]

virtual unsigned int IMyMoneySerialize::fileFixVersion ( void   )  const [pure virtual]

virtual void IMyMoneySerialize::setUser ( const MyMoneyPayee val  )  [pure virtual]

virtual void IMyMoneySerialize::setCreationDate ( const QDate &  val  )  [pure virtual]

virtual void IMyMoneySerialize::setFileFixVersion ( const unsigned int  v  )  [pure virtual]

virtual KSharedPtr<MyMoneyStorageSql> IMyMoneySerialize::connectToDatabase ( const KURL &  url  )  [pure virtual]

This method is used to get a SQL reader for subsequent database access

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::fillStorage (  )  [pure virtual]

This method is used when a database file is open, and the data is to be saved in a different file or format. It will ensure that all data from the database is available in memory to enable it to be written.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::setLastModificationDate ( const QDate &  val  )  [pure virtual]

This method is used to set the last modification date of the storage object. It also clears the dirty flag and should therefor be called as last operation when loading from a file.

Parameters:
val QDate of last modification

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::accountList ( QValueList< MyMoneyAccount > &  list  )  const [pure virtual]

This method returns a list of accounts inside the storage object.

Parameters:
list reference to QValueList receiving the account objects
Note:
The standard accounts will not be returned

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyInstitution> IMyMoneySerialize::institutionList ( void   )  const [pure virtual]

This method returns a list of the institutions inside a MyMoneyStorage object

Returns:
QMap containing the institution information

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::transactionList ( QValueList< MyMoneyTransaction > &  list,
MyMoneyTransactionFilter filter 
) const [pure virtual]

This method is used to pull a list of transactions from the file global transaction pool. It returns all those transactions that match the filter passed as argument. If the filter is empty, the whole journal will be returned.

Parameters:
list reference to QValueList<MyMoneyTransaction> receiving the set of transactions
filter MyMoneyTransactionFilter object with the match criteria

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual bool IMyMoneySerialize::isDuplicateTransaction ( const QString &   )  const [pure virtual]

This method returns whether a given transaction is already in memory, to avoid reloading it from the database

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyPayee> IMyMoneySerialize::payeeList ( void   )  const [pure virtual]

This method returns a list of the payees inside a MyMoneyStorage object

Returns:
QValueList<MyMoneyPayee> containing the payee information

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneySchedule> IMyMoneySerialize::scheduleList ( const QString &  = QString(),
const MyMoneySchedule::typeE  = MyMoneySchedule::TYPE_ANY,
const MyMoneySchedule::occurenceE  = MyMoneySchedule::OCCUR_ANY,
const MyMoneySchedule::paymentTypeE  = MyMoneySchedule::STYPE_ANY,
const QDate &  = QDate(),
const QDate &  = QDate(),
const   bool = false 
) const [pure virtual]

This method returns a list of the scheduled transactions inside a MyMoneyStorage object. In order to retrieve a complete list of the transactions, all arguments should be used with their default arguments.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneySecurity> IMyMoneySerialize::securityList ( void   )  const [pure virtual]

This method returns a list of security objects that the engine has knowledge of.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyAccount IMyMoneySerialize::liability ( void   )  const [pure virtual]

This method is used to return the standard liability account

Returns:
MyMoneyAccount liability account(group)

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyAccount IMyMoneySerialize::asset ( void   )  const [pure virtual]

This method is used to return the standard asset account

Returns:
MyMoneyAccount asset account(group)

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyAccount IMyMoneySerialize::expense ( void   )  const [pure virtual]

This method is used to return the standard expense account

Returns:
MyMoneyAccount expense account(group)

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyAccount IMyMoneySerialize::income ( void   )  const [pure virtual]

This method is used to return the standard income account

Returns:
MyMoneyAccount income account(group)

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyAccount IMyMoneySerialize::equity ( void   )  const [pure virtual]

This method is used to return the standard equity account

Returns:
MyMoneyAccount equity account(group)

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::addAccount ( MyMoneyAccount account  )  [pure virtual]

This method is used to create a new account

An exception will be thrown upon error conditions.

Parameters:
account MyMoneyAccount filled with data

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::addAccount ( MyMoneyAccount parent,
MyMoneyAccount account 
) [pure virtual]

This method is used to add one account as sub-ordinate to another (parent) account. The objects that are passed will be modified accordingly.

An exception will be thrown upon error conditions.

Parameters:
parent parent account the account should be added to
account the account to be added
Deprecated:
This method is only provided as long as we provide the version 0.4 binary reader. As soon as we deprecate this compatability mode this method will disappear from this interface!

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::addPayee ( MyMoneyPayee payee  )  [pure virtual]

This method is used to create a new payee

An exception will be thrown upon error conditions

Parameters:
payee MyMoneyPayee reference to payee information
Deprecated:
This method is only provided as long as we provide the version 0.4 binary reader. As soon as we deprecate this compatability mode this method will disappear from this interface!

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::addInstitution ( MyMoneyInstitution institution  )  [pure virtual]

Adds an institution to the storage. A respective institution-ID will be generated within this record. The ID is stored as QString in the object passed as argument.

An exception will be thrown upon error conditions.

Parameters:
institution The complete institution information in a MyMoneyInstitution object
Deprecated:
This method is only provided as long as we provide the version 0.4 binary reader. As soon as we deprecate this compatability mode this method will disappear from this interface!

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::addTransaction ( MyMoneyTransaction transaction,
const bool  skipAccountUpdate = false 
) [pure virtual]

Adds a transaction to the file-global transaction pool. A respective transaction-ID will be generated within this record. The ID is stored as QString with the object.

An exception will be thrown upon error conditions.

Parameters:
transaction reference to the transaction
skipAccountUpdate if set, the transaction lists of the accounts referenced in the splits are not updated. This is used for bulk loading a lot of transactions but not during normal operation. Refreshing the account's transaction list can be done using refreshAllAccountTransactionList().
Deprecated:
This method is only provided as long as we provide the version 0.4 binary reader. As soon as we deprecate this compatability mode this method will disappear from this interface!

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::loadAccounts ( const QMap< QString, MyMoneyAccount > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadTransactions ( const QMap< QString, MyMoneyTransaction > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadInstitutions ( const QMap< QString, MyMoneyInstitution > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadPayees ( const QMap< QString, MyMoneyPayee > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadSchedules ( const QMap< QString, MyMoneySchedule > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadSecurities ( const QMap< QString, MyMoneySecurity > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadCurrencies ( const QMap< QString, MyMoneySecurity > &  map  )  [pure virtual]

virtual void IMyMoneySerialize::loadReports ( const QMap< QString, MyMoneyReport > &  reports  )  [pure virtual]

virtual void IMyMoneySerialize::loadBudgets ( const QMap< QString, MyMoneyBudget > &  budgets  )  [pure virtual]

virtual void IMyMoneySerialize::loadPrices ( const MyMoneyPriceList list  )  [pure virtual]

virtual unsigned long IMyMoneySerialize::accountId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::transactionId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::payeeId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::institutionId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::scheduleId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::securityId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::reportId ( void   )  const [pure virtual]

virtual unsigned long IMyMoneySerialize::budgetId ( void   )  const [pure virtual]

virtual void IMyMoneySerialize::loadAccountId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadTransactionId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadPayeeId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadInstitutionId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadScheduleId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadSecurityId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadReportId ( const unsigned long  id  )  [pure virtual]

virtual void IMyMoneySerialize::loadBudgetId ( const unsigned long  id  )  [pure virtual]

virtual const QMap<QString, QString> IMyMoneySerialize::pairs ( void   )  const [pure virtual]

This method is used to retrieve the whole set of key/value pairs from the container. It is meant to be used for permanent storage functionality. See MyMoneyKeyValueContainer::pairs() for details.

Returns:
QMap<QString, QString> containing all key/value pairs of this container.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::setPairs ( const QMap< QString, QString > &  list  )  [pure virtual]

This method is used to initially store a set of key/value pairs in the container. It is meant to be used for loading functionality from permanent storage. See MyMoneyKeyValueContainer::setPairs() for details

Parameters:
list const QMap<QString, QString> containing the set of key/value pairs to be loaded into the container.
Note:
All existing key/value pairs in the container will be deleted.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneySchedule> IMyMoneySerialize::scheduleListEx ( int  scheduleTypes,
int  scheduleOcurrences,
int  schedulePaymentTypes,
QDate  startDate,
const QStringList &  accounts = QStringList() 
) const [pure virtual]

virtual const QValueList<MyMoneySecurity> IMyMoneySerialize::currencyList ( void   )  const [pure virtual]

This method is used to retrieve the list of all currencies known to the engine.

An exception will be thrown upon erronous situations.

Returns:
QValueList of all MyMoneySecurity objects representing a currency.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyReport> IMyMoneySerialize::reportList ( void   )  const [pure virtual]

This method is used to retrieve the list of all reports known to the engine.

An exception will be thrown upon erronous situations.

Returns:
QValueList of all MyMoneyReport objects.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyBudget> IMyMoneySerialize::budgetList ( void   )  const [pure virtual]

This method is used to retrieve the list of all budgets known to the engine.

An exception will be thrown upon erronous situations.

Returns:
QValueList of all MyMoneyBudget objects.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::addPrice ( const MyMoneyPrice price  )  [pure virtual]

This method adds a price entry to the price list.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyPriceList IMyMoneySerialize::priceList ( void   )  const [pure virtual]

This method returns a list of all prices.

Returns:
MyMoneyPriceList of all MyMoneyPrice objects.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneySerialize::rebuildAccountBalances ( void   )  [pure virtual]

This method recalculates the balances of all accounts based on the transactions stored in the engine.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.


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

Generated on Wed Jan 26 13:05:35 2011 for KMyMoney by  doxygen 1.5.6