IMyMoneyStorage Class Reference

#include <imymoneystorage.h>

Inheritance diagram for IMyMoneyStorage:

MyMoneyDatabaseMgr MyMoneySeqAccessMgr

List of all members.

Public Types

enum  ReferenceCheckBits {
  RefCheckAccount = 0, RefCheckInstitution, RefCheckPayee, RefCheckTransaction,
  RefCheckReport, RefCheckBudget, RefCheckSchedule, RefCheckSecurity,
  RefCheckCurrency, RefCheckPrice, MaxRefCheckBits
}

Public Member Functions

 IMyMoneyStorage ()
virtual ~IMyMoneyStorage ()
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 &user)=0
virtual void setFileFixVersion (const unsigned int v)=0
virtual void setValue (const QString &key, const QString &value)=0
virtual const QString value (const QString &key) const =0
virtual void deletePair (const QString &key)=0
virtual IMyMoneyStorage const * duplicate (void)=0
virtual void addAccount (MyMoneyAccount &account)=0
virtual void addAccount (MyMoneyAccount &parent, MyMoneyAccount &account)=0
virtual void addPayee (MyMoneyPayee &payee)=0
virtual const MyMoneyPayee payee (const QString &id) const =0
virtual const MyMoneyPayee payeeByName (const QString &payee) const =0
virtual void modifyPayee (const MyMoneyPayee &payee)=0
virtual void removePayee (const MyMoneyPayee &payee)=0
virtual const QValueList
< MyMoneyPayee
payeeList (void) const =0
virtual const MyMoneyAccount account (const QString &id) const =0
virtual bool isStandardAccount (const QString &id) const =0
virtual void setAccountName (const QString &id, const QString &name)=0
virtual void addInstitution (MyMoneyInstitution &institution)=0
virtual void addTransaction (MyMoneyTransaction &transaction, const bool skipAccountUpdate=false)=0
virtual bool hasActiveSplits (const QString &id) const =0
virtual const MyMoneyMoney balance (const QString &id, const QDate &date) const =0
virtual const MyMoneyMoney totalBalance (const QString &id, const QDate &date) const =0
virtual const MyMoneyInstitution institution (const QString &id) const =0
virtual bool dirty (void) const =0
virtual void setDirty (void)=0
virtual unsigned int accountCount (void) const =0
virtual const QValueList
< MyMoneyInstitution
institutionList (void) const =0
virtual void modifyAccount (const MyMoneyAccount &account, const bool skipCheck=false)=0
virtual void modifyInstitution (const MyMoneyInstitution &institution)=0
virtual void modifyTransaction (const MyMoneyTransaction &transaction)=0
virtual void reparentAccount (MyMoneyAccount &account, MyMoneyAccount &parent)=0
virtual void removeTransaction (const MyMoneyTransaction &transaction)=0
virtual unsigned int transactionCount (const QString &account=QString()) const =0
virtual const QMap< QString,
unsigned long > 
transactionCountMap (void) const =0
virtual const QValueList
< MyMoneyTransaction
transactionList (MyMoneyTransactionFilter &filter) const =0
virtual void transactionList (QValueList< MyMoneyTransaction > &list, MyMoneyTransactionFilter &filter) const =0
virtual void transactionList (QValueList< QPair< MyMoneyTransaction, MyMoneySplit > > &list, MyMoneyTransactionFilter &filter) const =0
virtual void removeAccount (const MyMoneyAccount &account)=0
virtual void removeInstitution (const MyMoneyInstitution &institution)=0
virtual const MyMoneyTransaction transaction (const QString &id) const =0
virtual const MyMoneyTransaction transaction (const QString &account, const int idx) const =0
virtual unsigned int institutionCount (void) const =0
virtual void accountList (QValueList< MyMoneyAccount > &list) 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 addSecurity (MyMoneySecurity &security)=0
virtual void modifySecurity (const MyMoneySecurity &security)=0
virtual void removeSecurity (const MyMoneySecurity &security)=0
virtual const MyMoneySecurity security (const QString &id) const =0
virtual const QValueList
< MyMoneySecurity
securityList (void) const =0
virtual void addPrice (const MyMoneyPrice &price)=0
virtual void removePrice (const MyMoneyPrice &price)=0
virtual const MyMoneyPrice price (const QString &fromId, const QString &toId, const QDate &date, const bool exactDate) const =0
virtual const MyMoneyPriceList priceList (void) const =0
virtual void addSchedule (MyMoneySchedule &sched)=0
virtual void modifySchedule (const MyMoneySchedule &sched)=0
virtual void removeSchedule (const MyMoneySchedule &sched)=0
virtual const MyMoneySchedule schedule (const QString &id) const =0
virtual const QValueList
< MyMoneySchedule
scheduleList (const QString &accountId=QString(), const MyMoneySchedule::typeE type=MyMoneySchedule::TYPE_ANY, const MyMoneySchedule::occurenceE occurence=MyMoneySchedule::OCCUR_ANY, const MyMoneySchedule::paymentTypeE paymentType=MyMoneySchedule::STYPE_ANY, const QDate &startDate=QDate(), const QDate &endDate=QDate(), const bool overdue=false) const =0
virtual const QValueList
< MyMoneySchedule
scheduleListEx (int scheduleTypes, int scheduleOcurrences, int schedulePaymentTypes, QDate startDate, const QStringList &accounts=QStringList()) const =0
virtual void addCurrency (const MyMoneySecurity &currency)=0
virtual void modifyCurrency (const MyMoneySecurity &currency)=0
virtual void removeCurrency (const MyMoneySecurity &currency)=0
virtual const MyMoneySecurity currency (const QString &id) const =0
virtual const QValueList
< MyMoneySecurity
currencyList (void) const =0
virtual const QValueList
< MyMoneyReport
reportList (void) const =0
virtual void addReport (MyMoneyReport &report)=0
virtual void modifyReport (const MyMoneyReport &report)=0
virtual unsigned countReports (void) const =0
virtual const MyMoneyReport report (const QString &id) const =0
virtual void removeReport (const MyMoneyReport &report)=0
virtual const QValueList
< MyMoneyBudget
budgetList (void) const =0
virtual void addBudget (MyMoneyBudget &budget)=0
virtual const MyMoneyBudget budgetByName (const QString &budget) const =0
virtual void modifyBudget (const MyMoneyBudget &budget)=0
virtual unsigned countBudgets (void) const =0
virtual MyMoneyBudget budget (const QString &id) const =0
virtual void removeBudget (const MyMoneyBudget &budget)=0
virtual void clearCache (void)=0
virtual bool isReferenced (const MyMoneyObject &obj, const MyMoneyFileBitArray &skipCheck=MyMoneyFileBitArray()) const =0
virtual void close (void)=0
virtual void startTransaction (void)=0
virtual bool commitTransaction (void)=0
virtual void rollbackTransaction (void)=0


Detailed Description

Author:
Thomas Baumgart The IMyMoneyStorage class describes the interface between the MyMoneyFile class and the real storage manager.
See also:
MyMoneySeqAccessMgr

Member Enumeration Documentation

Enumerator:
RefCheckAccount 
RefCheckInstitution 
RefCheckPayee 
RefCheckTransaction 
RefCheckReport 
RefCheckBudget 
RefCheckSchedule 
RefCheckSecurity 
RefCheckCurrency 
RefCheckPrice 
MaxRefCheckBits 


Constructor & Destructor Documentation

IMyMoneyStorage::IMyMoneyStorage (  ) 

virtual IMyMoneyStorage::~IMyMoneyStorage (  )  [virtual]


Member Function Documentation

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

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

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

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

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

virtual void IMyMoneyStorage::setUser ( const MyMoneyPayee user  )  [pure virtual]

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

virtual void IMyMoneyStorage::setValue ( const QString &  key,
const QString &  value 
) [pure virtual]

virtual const QString IMyMoneyStorage::value ( const QString &  key  )  const [pure virtual]

virtual void IMyMoneyStorage::deletePair ( const QString &  key  )  [pure virtual]

virtual IMyMoneyStorage const* IMyMoneyStorage::duplicate ( void   )  [pure virtual]

This method is used to duplicate an IMyMoneyStorage object and return a pointer to the newly created copy. The caller of this method is the new owner of the object and must destroy it.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::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 IMyMoneyStorage::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

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::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

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyPayee IMyMoneyStorage::payee ( const QString &  id  )  const [pure virtual]

This method is used to retrieve information about a payee An exception will be thrown upon error conditions.

Parameters:
id QString reference to id of payee
Returns:
MyMoneyPayee object of payee

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyPayee IMyMoneyStorage::payeeByName ( const QString &  payee  )  const [pure virtual]

This method is used to retrieve the id to a corresponding name of a payee/receiver. An exception will be thrown upon error conditions.

Parameters:
payee QString reference to name of payee
Returns:
MyMoneyPayee object of payee

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyPayee ( const MyMoneyPayee payee  )  [pure virtual]

This method is used to modify an existing payee

An exception will be thrown upon error conditions

Parameters:
payee MyMoneyPayee reference to payee information

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removePayee ( const MyMoneyPayee payee  )  [pure virtual]

This method is used to remove an existing payee

An exception will be thrown upon error conditions

Parameters:
payee MyMoneyPayee reference to payee information

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyPayee> IMyMoneyStorage::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 MyMoneyAccount IMyMoneyStorage::account ( const QString &  id  )  const [pure virtual]

Returns the account addressed by it's id.

An exception will be thrown upon error conditions.

Parameters:
id id of the account to locate.
Returns:
reference to MyMoneyAccount object. An exception is thrown if the id is unknown

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual bool IMyMoneyStorage::isStandardAccount ( const QString &  id  )  const [pure virtual]

This method is used to check whether a given account id references one of the standard accounts or not.

An exception will be thrown upon error conditions.

Parameters:
id account id
Returns:
true if account-id is one of the standards, false otherwise

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::setAccountName ( const QString &  id,
const QString &  name 
) [pure virtual]

This method is used to set the name for the specified standard account within the storage area. An exception will be thrown, if an error occurs

Parameters:
id QString reference to one of the standard accounts.
name QString reference to the name to be set

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::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

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::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 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

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual bool IMyMoneyStorage::hasActiveSplits ( const QString &  id  )  const [pure virtual]

This method is used to determince, if the account with the given ID is referenced by any split in m_transactionList.

An exception will be thrown upon error conditions.

Parameters:
id id of the account to be checked for
Returns:
true if account is referenced, false otherwise

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyMoney IMyMoneyStorage::balance ( const QString &  id,
const QDate &  date 
) const [pure virtual]

This method is used to return the actual balance of an account without it's sub-ordinate accounts. If a date is presented, the balance at the beginning of this date (not including any transaction on this date) is returned. Otherwise all recorded transactions are included in the balance.

Parameters:
id id of the account in question
date return balance for specific date
Returns:
balance of the account as MyMoneyMoney object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyMoney IMyMoneyStorage::totalBalance ( const QString &  id,
const QDate &  date 
) const [pure virtual]

This method is used to return the actual balance of an account including it's sub-ordinate accounts. If a date is presented, the balance at the beginning of this date (not including any transaction on this date) is returned. Otherwise all recorded transactions are included in the balance.

Parameters:
id id of the account in question
date return balance for specific date
Returns:
balance of the account as MyMoneyMoney object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyInstitution IMyMoneyStorage::institution ( const QString &  id  )  const [pure virtual]

Returns the institution of a given ID

Parameters:
id id of the institution to locate
Returns:
MyMoneyInstitution object filled with data. If the institution could not be found, an exception will be thrown

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual bool IMyMoneyStorage::dirty ( void   )  const [pure virtual]

This method returns an indicator if the storage object has been changed after it has last been saved to permanent storage.

Returns:
true if changed, false if not

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::setDirty ( void   )  [pure virtual]

This method can be used by an external object to force the storage object to be dirty. This is used e.g. when an upload to an external destination failed but the previous storage to a local disk was ok.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual unsigned int IMyMoneyStorage::accountCount ( void   )  const [pure virtual]

This method returns the number of accounts currently known to this storage in the range 0..MAXUINT

Returns:
number of accounts currently known inside a MyMoneyFile object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

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

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

Returns:
QValueList<MyMoneyInstitution> containing the institution information

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyAccount ( const MyMoneyAccount account,
const bool  skipCheck = false 
) [pure virtual]

Modifies an already existing account in the file global account pool.

An exception will be thrown upon error conditions.

Parameters:
account reference to the new account information
skipCheck allows to skip the builtin consistency checks

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyInstitution ( const MyMoneyInstitution institution  )  [pure virtual]

Modifies an already existing institution in the file global institution pool.

An exception will be thrown upon error conditions.

Parameters:
institution The complete new institution information

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyTransaction ( const MyMoneyTransaction transaction  )  [pure virtual]

This method is used to update a specific transaction in the transaction pool of the MyMoneyFile object

An exception will be thrown upon error conditions.

Parameters:
transaction reference to transaction to be changed

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::reparentAccount ( MyMoneyAccount account,
MyMoneyAccount parent 
) [pure virtual]

This method re-parents an existing account

An exception will be thrown upon error conditions.

Parameters:
account MyMoneyAccount reference to account to be re-parented
parent MyMoneyAccount reference to new parent account

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeTransaction ( const MyMoneyTransaction transaction  )  [pure virtual]

This method is used to remove a transaction from the transaction pool (journal).

An exception will be thrown upon error conditions.

Parameters:
transaction const reference to transaction to be deleted

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual unsigned int IMyMoneyStorage::transactionCount ( const QString &  account = QString()  )  const [pure virtual]

This method returns the number of transactions currently known to file in the range 0..MAXUINT

Parameters:
account QString reference to account id. If account is empty + all transactions (the journal) will be counted. If account is not empty it returns the number of transactions that have splits in this account.
Returns:
number of transactions in journal/account

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QMap<QString, unsigned long> IMyMoneyStorage::transactionCountMap ( void   )  const [pure virtual]

This method returns a QMap filled with the number of transactions per account. The account id serves as index into the map. If one needs to have all transactionCounts() for many accounts, this method is faster than calling transactionCount(const QString& account) many times.

Returns:
QMap with numbers of transactions per account

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyTransaction> IMyMoneyStorage::transactionList ( 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. The list returned is sorted according to the transactions posting date. If more than one transaction exists for the same date, the order among them is undefined.

Parameters:
filter MyMoneyTransactionFilter object with the match criteria
Returns:
set of transactions in form of a QValueList<MyMoneyTransaction>

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

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

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

virtual void IMyMoneyStorage::removeAccount ( const MyMoneyAccount account  )  [pure virtual]

Deletes an existing account from the file global account pool This method only allows to remove accounts that are not referenced by any split. Use moveSplits() to move splits to another account. An exception is thrown in case of a problem.

Parameters:
account reference to the account to be deleted.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeInstitution ( const MyMoneyInstitution institution  )  [pure virtual]

Deletes an existing institution from the file global institution pool Also modifies the accounts that reference this institution as their institution.

An exception will be thrown upon error conditions.

Parameters:
institution institution to be deleted.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyTransaction IMyMoneyStorage::transaction ( const QString &  id  )  const [pure virtual]

This method is used to extract a transaction from the file global transaction pool through an id. In case of an invalid id, an exception will be thrown.

Parameters:
id id of transaction as QString.
Returns:
reference to the requested transaction

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyTransaction IMyMoneyStorage::transaction ( const QString &  account,
const int  idx 
) const [pure virtual]

This method is used to extract a transaction from the file global transaction pool through an index into an account.

Parameters:
account id of the account as QString
idx number of transaction in this account
Returns:
reference to MyMoneyTransaction object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual unsigned int IMyMoneyStorage::institutionCount ( void   )  const [pure virtual]

This method returns the number of institutions currently known to file in the range 0..MAXUINT

Returns:
number of institutions known to file

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::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 MyMoneyAccount IMyMoneyStorage::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 IMyMoneyStorage::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 IMyMoneyStorage::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 IMyMoneyStorage::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 IMyMoneyStorage::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 IMyMoneyStorage::addSecurity ( MyMoneySecurity security  )  [pure virtual]

This method is used to create a new security object. The ID will be created automatically. The object passed with the parameter security is modified to contain the assigned id.

An exception will be thrown upon error conditions.

Parameters:
security MyMoneySecurity filled with data

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifySecurity ( const MyMoneySecurity security  )  [pure virtual]

This method is used to modify an existing MyMoneySecurity object.

An exception will be thrown upon erronous situations.

Parameters:
security reference to the MyMoneySecurity object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeSecurity ( const MyMoneySecurity security  )  [pure virtual]

This method is used to remove an existing MyMoneySecurity object from the engine.

An exception will be thrown upon erronous situations.

Parameters:
security reference to the MyMoneySecurity object to be removed

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneySecurity IMyMoneyStorage::security ( const QString &  id  )  const [pure virtual]

This method is used to retrieve a single MyMoneySecurity object. The id of the object must be supplied in the parameter id.

An exception will be thrown upon erronous situations.

Parameters:
id QString containing the id of the MyMoneySecurity object
Returns:
MyMoneySecurity object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

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

This method returns a list of the security objects inside a MyMoneyStorage object

Returns:
QValueList<MyMoneySecurity> containing objects

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

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

virtual void IMyMoneyStorage::removePrice ( const MyMoneyPrice price  )  [pure virtual]

virtual const MyMoneyPrice IMyMoneyStorage::price ( const QString &  fromId,
const QString &  toId,
const QDate &  date,
const bool  exactDate 
) const [pure virtual]

virtual const MyMoneyPriceList IMyMoneyStorage::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 IMyMoneyStorage::addSchedule ( MyMoneySchedule sched  )  [pure virtual]

This method is used to add a scheduled transaction to the engine. It must be sure, that the id of the object is not filled. When the method returns to the caller, the id will be filled with the newly created object id value.

An exception will be thrown upon erronous situations.

Parameters:
sched reference to the MyMoneySchedule object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifySchedule ( const MyMoneySchedule sched  )  [pure virtual]

This method is used to modify an existing MyMoneySchedule object. Therefor, the id attribute of the object must be set.

An exception will be thrown upon erronous situations.

Parameters:
sched const reference to the MyMoneySchedule object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeSchedule ( const MyMoneySchedule sched  )  [pure virtual]

This method is used to remove an existing MyMoneySchedule object from the engine. The id attribute of the object must be set.

An exception will be thrown upon erronous situations.

Parameters:
sched const reference to the MyMoneySchedule object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneySchedule IMyMoneyStorage::schedule ( const QString &  id  )  const [pure virtual]

This method is used to retrieve a single MyMoneySchedule object. The id of the object must be supplied in the parameter id.

An exception will be thrown upon erronous situations.

Parameters:
id QString containing the id of the MyMoneySchedule object
Returns:
MyMoneySchedule object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneySchedule> IMyMoneyStorage::scheduleList ( const QString &  accountId = QString(),
const MyMoneySchedule::typeE  type = MyMoneySchedule::TYPE_ANY,
const MyMoneySchedule::occurenceE  occurence = MyMoneySchedule::OCCUR_ANY,
const MyMoneySchedule::paymentTypeE  paymentType = MyMoneySchedule::STYPE_ANY,
const QDate &  startDate = QDate(),
const QDate &  endDate = QDate(),
const bool  overdue = false 
) const [pure virtual]

This method is used to extract a list of scheduled transactions according to the filter criteria passed as arguments.

Parameters:
accountId only search for scheduled transactions that reference accound accountId. If accountId is the empty string, this filter is off. Default is QString().
type only schedules of type type are searched for. See MyMoneySchedule::typeE for details. Default is MyMoneySchedule::TYPE_ANY
occurence only schedules of occurence type occurance are searched for. See MyMoneySchedule::occurenceE for details. Default is MyMoneySchedule::OCCUR_ANY
paymentType only schedules of payment method paymentType are searched for. See MyMoneySchedule::paymentTypeE for details. Default is MyMoneySchedule::STYPE_ANY
startDate only schedules with payment dates after startDate are searched for. Default is all dates (QDate()).
endDate only schedules with payment dates ending prior to endDate are searched for. Default is all dates (QDate()).
overdue if true, only those schedules that are overdue are searched for. Default is false (all schedules will be returned).
Returns:
const QValueList<MyMoneySchedule> list of schedule objects.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

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

virtual void IMyMoneyStorage::addCurrency ( const MyMoneySecurity currency  )  [pure virtual]

This method is used to add a new currency object to the engine. The ID of the object is the trading symbol, so there is no need for an additional ID since the symbol is guaranteed to be unique.

An exception will be thrown upon erronous situations.

Parameters:
currency reference to the MyMoneySecurity object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyCurrency ( const MyMoneySecurity currency  )  [pure virtual]

This method is used to modify an existing MyMoneySecurity object.

An exception will be thrown upon erronous situations.

Parameters:
currency reference to the MyMoneyCurrency object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeCurrency ( const MyMoneySecurity currency  )  [pure virtual]

This method is used to remove an existing MyMoneySecurity object from the engine.

An exception will be thrown upon erronous situations.

Parameters:
currency reference to the MyMoneySecurity object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneySecurity IMyMoneyStorage::currency ( const QString &  id  )  const [pure virtual]

This method is used to retrieve a single MyMoneySecurity object. The id of the object must be supplied in the parameter id.

An exception will be thrown upon erronous situations.

Parameters:
id QString containing the id of the MyMoneySecurity object
Returns:
MyMoneyCurrency object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneySecurity> IMyMoneyStorage::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> IMyMoneyStorage::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 void IMyMoneyStorage::addReport ( MyMoneyReport report  )  [pure virtual]

This method is used to add a new report to the engine. It must be sure, that the id of the object is not filled. When the method returns to the caller, the id will be filled with the newly created object id value.

An exception will be thrown upon erronous situations.

Parameters:
report reference to the MyMoneyReport object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyReport ( const MyMoneyReport report  )  [pure virtual]

This method is used to modify an existing MyMoneyReport object. Therefor, the id attribute of the object must be set.

An exception will be thrown upon erronous situations.

Parameters:
report const reference to the MyMoneyReport object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual unsigned IMyMoneyStorage::countReports ( void   )  const [pure virtual]

This method returns the number of reports currently known to file in the range 0..MAXUINT

Returns:
number of reports known to file

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyReport IMyMoneyStorage::report ( const QString &  id  )  const [pure virtual]

This method is used to retrieve a single MyMoneyReport object. The id of the object must be supplied in the parameter id.

An exception will be thrown upon erronous situations.

Parameters:
id QString containing the id of the MyMoneyReport object
Returns:
MyMoneyReport object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeReport ( const MyMoneyReport report  )  [pure virtual]

This method is used to remove an existing MyMoneyReport object from the engine. The id attribute of the object must be set.

An exception will be thrown upon erronous situations.

Parameters:
report const reference to the MyMoneyReport object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const QValueList<MyMoneyBudget> IMyMoneyStorage::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 IMyMoneyStorage::addBudget ( MyMoneyBudget budget  )  [pure virtual]

This method is used to add a new budget to the engine. It must be sure, that the id of the object is not filled. When the method returns to the caller, the id will be filled with the newly created object id value.

An exception will be thrown upon erronous situations.

Parameters:
budget reference to the MyMoneyBudget object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual const MyMoneyBudget IMyMoneyStorage::budgetByName ( const QString &  budget  )  const [pure virtual]

This method is used to retrieve the id to a corresponding name of a budget An exception will be thrown upon error conditions.

Parameters:
budget QString reference to name of budget
Returns:
MyMoneyBudget object of budget

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::modifyBudget ( const MyMoneyBudget budget  )  [pure virtual]

This method is used to modify an existing MyMoneyBudget object. Therefor, the id attribute of the object must be set.

An exception will be thrown upon erronous situations.

Parameters:
budget const reference to the MyMoneyBudget object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual unsigned IMyMoneyStorage::countBudgets ( void   )  const [pure virtual]

This method returns the number of budgets currently known to file in the range 0..MAXUINT

Returns:
number of budgets known to file

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual MyMoneyBudget IMyMoneyStorage::budget ( const QString &  id  )  const [pure virtual]

This method is used to retrieve a single MyMoneyBudget object. The id of the object must be supplied in the parameter id.

An exception will be thrown upon erronous situations.

Parameters:
id QString containing the id of the MyMoneyBudget object
Returns:
MyMoneyBudget object

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::removeBudget ( const MyMoneyBudget budget  )  [pure virtual]

This method is used to remove an existing MyMoneyBudget object from the engine. The id attribute of the object must be set.

An exception will be thrown upon erronous situations.

Parameters:
budget const reference to the MyMoneyBudget object to be updated

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::clearCache ( void   )  [pure virtual]

Clear all internal caches (used internally for performance measurements)

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual bool IMyMoneyStorage::isReferenced ( const MyMoneyObject obj,
const MyMoneyFileBitArray skipCheck = MyMoneyFileBitArray() 
) const [pure virtual]

This method checks, if the given object is referenced by another engine object.

Parameters:
obj const reference to object to be checked
skipCheck MyMoneyFileBitArray with ReferenceCheckBits set for which the check should be skipped
Return values:
false object is not referenced
true institution is referenced

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::close ( void   )  [pure virtual]

This method is provided to allow closing of the database before logoff

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual void IMyMoneyStorage::startTransaction ( void   )  [pure virtual]

These methods have to be provided to allow transaction safe data handling.

Implemented in MyMoneyDatabaseMgr, and MyMoneySeqAccessMgr.

virtual bool IMyMoneyStorage::commitTransaction ( void   )  [pure virtual]

virtual void IMyMoneyStorage::rollbackTransaction ( void   )  [pure virtual]


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