mymoneydatabasemgr.h

Go to the documentation of this file.

/***************************************************************************
                          mymoneydatabasemgr.h  -  description
                             -------------------
    begin                : June 5 2007
    copyright            : (C) 2007 by Fernando Vilas
    email                : Fernando Vilas <fvilas@iname.com>
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef MYMONEYDATABASEMGR_H
#define MYMONEYDATABASEMGR_H

// ----------------------------------------------------------------------------
// QT Includes

// ----------------------------------------------------------------------------
// Project Includes

#include "imymoneyserialize.h"
#include "imymoneystorage.h"
#include "mymoneymap.h"
#include "mymoneystoragesql.h"

class MyMoneyDatabaseMgr : public IMyMoneyStorage, public IMyMoneySerialize,
                            public MyMoneyKeyValueContainer
{
public:
  MyMoneyDatabaseMgr();
  ~MyMoneyDatabaseMgr();

  // general get functions
  virtual const MyMoneyPayee user(void) const;
  virtual const QDate creationDate(void) const;
  virtual const QDate lastModificationDate(void) const;
  virtual unsigned int currentFixVersion(void) const;
  virtual unsigned int fileFixVersion(void) const;

  // general set functions
  virtual void setUser(const MyMoneyPayee& user);
  virtual void setFileFixVersion(const unsigned int v);

  // methods provided by MyMoneyKeyValueContainer
  virtual void setValue(const QString& key, const QString& value);
  virtual const QString value(const QString& key) const;
  virtual void deletePair(const QString& key);

  virtual MyMoneyDatabaseMgr const * duplicate(void);

  virtual void addAccount(MyMoneyAccount& account);

  virtual void addAccount(MyMoneyAccount& parent, MyMoneyAccount& account);

  virtual void addPayee(MyMoneyPayee& payee);

  virtual const MyMoneyPayee payee(const QString& id) const;

  virtual const MyMoneyPayee payeeByName(const QString& payee) const;

  virtual void modifyPayee(const MyMoneyPayee& payee);

  virtual void removePayee(const MyMoneyPayee& payee);

  virtual const QValueList<MyMoneyPayee> payeeList(void) const;

  virtual const MyMoneyAccount account(const QString& id) const;

  virtual bool isStandardAccount(const QString& id) const;

  virtual void setAccountName(const QString& id, const QString& name);

  virtual void addInstitution(MyMoneyInstitution& institution);

  virtual void addTransaction(MyMoneyTransaction& transaction, const bool skipAccountUpdate = false);

  virtual bool hasActiveSplits(const QString& id) const;

  virtual const MyMoneyMoney balance(const QString& id, const QDate& date) const;

  virtual const MyMoneyMoney totalBalance(const QString& id, const QDate& date) const;

  virtual const MyMoneyInstitution institution(const QString& id) const;

  virtual bool dirty(void) const;

  virtual void setDirty(void);

  virtual unsigned int accountCount(void) const;

  virtual const QValueList<MyMoneyInstitution> institutionList(void) const;

  virtual void modifyAccount(const MyMoneyAccount& account, const bool skipCheck = false);

  virtual void modifyInstitution(const MyMoneyInstitution& institution);

  virtual void modifyTransaction(const MyMoneyTransaction& transaction);

  virtual void reparentAccount(MyMoneyAccount &account, MyMoneyAccount& parent);

  virtual void removeTransaction(const MyMoneyTransaction& transaction);

  virtual unsigned int transactionCount(const QString& account = QString()) const;

  virtual const QMap<QString, unsigned long> transactionCountMap(void) const;

  virtual const QValueList<MyMoneyTransaction> transactionList(MyMoneyTransactionFilter& filter) const;

  virtual void transactionList(QValueList<MyMoneyTransaction>& list, MyMoneyTransactionFilter& filter) const;

  virtual void transactionList(QValueList<QPair<MyMoneyTransaction, MyMoneySplit> >& list, MyMoneyTransactionFilter& filter) const;

  virtual void removeAccount(const MyMoneyAccount& account);

  virtual void removeInstitution(const MyMoneyInstitution& institution);

  virtual const MyMoneyTransaction transaction(const QString& id) const;

  virtual const MyMoneyTransaction transaction(const QString& account, const int idx) const;

  virtual unsigned int institutionCount(void) const;

  virtual void accountList(QValueList<MyMoneyAccount>& list) const;

  virtual const MyMoneyAccount liability(void) const;

  virtual const MyMoneyAccount asset(void) const;

  virtual const MyMoneyAccount expense(void) const;

  virtual const MyMoneyAccount income(void) const;

  virtual const MyMoneyAccount equity(void) const;

  virtual void addSecurity(MyMoneySecurity& security);

  virtual void modifySecurity(const MyMoneySecurity& security);

  virtual void removeSecurity(const MyMoneySecurity& security);

  virtual const MyMoneySecurity security(const QString& id) const;

  virtual const QValueList<MyMoneySecurity> securityList(void) const;

  virtual void addPrice(const MyMoneyPrice& price);
  virtual void removePrice(const MyMoneyPrice& price);
  virtual const MyMoneyPrice price(const QString& fromId, const QString& toId, const QDate& date, const bool exactDate) const;

  virtual const MyMoneyPriceList priceList(void) const;

  virtual void addSchedule(MyMoneySchedule& sched);

  virtual void modifySchedule(const MyMoneySchedule& sched);

  virtual void removeSchedule(const MyMoneySchedule& sched);

  virtual const MyMoneySchedule schedule(const QString& id) const;

  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;

  virtual const QValueList<MyMoneySchedule> scheduleListEx( int scheduleTypes,
                                              int scheduleOcurrences,
                                              int schedulePaymentTypes,
                                              QDate startDate,
                                              const QStringList& accounts=QStringList()) const;

  virtual void addCurrency(const MyMoneySecurity& currency);

  virtual void modifyCurrency(const MyMoneySecurity& currency);

  virtual void removeCurrency(const MyMoneySecurity& currency);

  virtual const MyMoneySecurity currency(const QString& id) const;

  virtual const QValueList<MyMoneySecurity> currencyList(void) const;

  virtual const QValueList<MyMoneyReport> reportList( void ) const;

  virtual void addReport( MyMoneyReport& report );

  virtual void modifyReport( const MyMoneyReport& report );

  virtual unsigned countReports( void ) const;

  virtual const MyMoneyReport report( const QString& id ) const;

  virtual void removeReport(const MyMoneyReport& report);

  virtual const QValueList<MyMoneyBudget> budgetList( void ) const;

  virtual void addBudget( MyMoneyBudget& budget );

  virtual const MyMoneyBudget budgetByName(const QString& budget) const;

  virtual void modifyBudget( const MyMoneyBudget& budget );

  virtual unsigned countBudgets( void ) const;

  virtual MyMoneyBudget budget( const QString& id ) const;

  virtual void removeBudget(const MyMoneyBudget& budget);



  virtual void clearCache(void);

  virtual bool isReferenced(const MyMoneyObject& obj, const MyMoneyFileBitArray& skipCheck = MyMoneyFileBitArray()) const;

  virtual void close(void);

  virtual void startTransaction(void);
  virtual bool commitTransaction(void);
  virtual void rollbackTransaction(void);

  // general set functions
  virtual void setCreationDate(const QDate& val);

  virtual KSharedPtr <MyMoneyStorageSql> connectToDatabase
      (const KURL& url);
  virtual void fillStorage();

  virtual void setLastModificationDate(const QDate& val);

  virtual bool isDuplicateTransaction(const QString&) const;

  virtual void loadAccounts(const QMap<QString, MyMoneyAccount>& map);
  virtual void loadTransactions(const QMap<QString, MyMoneyTransaction>& map);
  virtual void loadInstitutions(const QMap<QString, MyMoneyInstitution>& map);
  virtual void loadPayees(const QMap<QString, MyMoneyPayee>& map);
  virtual void loadSchedules(const QMap<QString, MyMoneySchedule>& map);
  virtual void loadSecurities(const QMap<QString, MyMoneySecurity>& map);
  virtual void loadCurrencies(const QMap<QString, MyMoneySecurity>& map);
  virtual void loadReports( const QMap<QString, MyMoneyReport>& reports );
  virtual void loadBudgets( const QMap<QString, MyMoneyBudget>& budgets );
  virtual void loadPrices(const MyMoneyPriceList& list);

  virtual unsigned long accountId(void) const;
  virtual unsigned long transactionId(void) const;
  virtual unsigned long payeeId(void) const;
  virtual unsigned long institutionId(void) const;
  virtual unsigned long scheduleId(void) const;
  virtual unsigned long securityId(void) const;
  virtual unsigned long reportId(void) const;
  virtual unsigned long budgetId(void) const;

  virtual void loadAccountId(const unsigned long id);
  virtual void loadTransactionId(const unsigned long id);
  virtual void loadPayeeId(const unsigned long id);
  virtual void loadInstitutionId(const unsigned long id);
  virtual void loadScheduleId(const unsigned long id);
  virtual void loadSecurityId(const unsigned long id);
  virtual void loadReportId(const unsigned long id);
  virtual void loadBudgetId(const unsigned long id);

  virtual const QMap<QString, QString> pairs(void) const;

  virtual void setPairs(const QMap<QString, QString>& list);

  virtual void rebuildAccountBalances(void);

private:
  QDate m_creationDate;

  unsigned int m_currentFixVersion;

  unsigned int m_fileFixVersion;

  QDate m_lastModificationDate;

  KSharedPtr <MyMoneyStorageSql> m_sql;

  MyMoneyPayee m_user;

  const QString nextInstitutionID(void);

  const QString nextAccountID(void);

  const QString nextTransactionID(void);

  const QString nextPayeeID(void);

  const QString nextScheduleID(void);

  const QString nextSecurityID(void);

  const QString nextReportID(void);

  const QString nextBudgetID(void);

  void removeReferences(const QString& id);

  static const int INSTITUTION_ID_SIZE = 6;
  static const int ACCOUNT_ID_SIZE = 6;
  static const int TRANSACTION_ID_SIZE = 18;
  static const int PAYEE_ID_SIZE = 6;
  static const int SCHEDULE_ID_SIZE = 6;
  static const int SECURITY_ID_SIZE = 6;
  static const int REPORT_ID_SIZE = 6;
  static const int BUDGET_ID_SIZE = 6;

  // Increment this to force an update in KMMView.
  // This is different from the db schema version stored in
  // MMStorageSql::m_majorVersion
  static const int CURRENT_FIX_VERSION = 3;

};
#endif