imymoneyserialize.h

Go to the documentation of this file.

/***************************************************************************
                          imymoneyserialize.h  -  description
                             -------------------
    begin                : Fri May 10 2002
    copyright            : (C) 2000-2002 by Michael Edwardes
    email                : mte@users.sourceforge.net
                           Javier Campos Morales <javi_c@users.sourceforge.net>
                           Felix Rodriguez <frodriguez@users.sourceforge.net>
                           John C <thetacoturtle@users.sourceforge.net>
                           Thomas Baumgart <ipwizard@users.sourceforge.net>
                           Kevin Tambascio <ktambascio@users.sourceforge.net>
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 IMYMONEYSERIALIZE_H
#define IMYMONEYSERIALIZE_H

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

#include <qstring.h>
#include <qvaluelist.h>

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

#include <kmymoney/mymoneyutils.h>
#include <kmymoney/mymoneyinstitution.h>
#include <kmymoney/mymoneyaccount.h>
#include <kmymoney/mymoneytransaction.h>
#include <kmymoney/mymoneypayee.h>
#include <kmymoney/mymoneyscheduled.h>
#include <kmymoney/mymoneytransactionfilter.h>
#include <kmymoney/mymoneysecurity.h>
#include <kmymoney/mymoneyprice.h>
#include <kmymoney/mymoneyreport.h>
#include <kmymoney/mymoneybudget.h>
#include "mymoneystoragesql.h"

class IMyMoneySerialize {
public:
  IMyMoneySerialize();
  virtual ~IMyMoneySerialize();

  // general get functions
  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;

  // general set functions
  virtual void setUser(const MyMoneyPayee& val) = 0;
  virtual void setCreationDate(const QDate& val) = 0;
  virtual void setFileFixVersion(const unsigned int v) = 0;
  virtual 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 const QValueList<MyMoneyTransaction> transactionList(const QCString& account = "") const = 0;

  virtual bool isDuplicateTransaction(const QCString&) const = 0;
  virtual const QValueList<MyMoneyPayee> payeeList(void) const = 0;

  virtual const QValueList<MyMoneySchedule> scheduleList(const QCString& = QCString(),
                                     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<QCString, MyMoneyAccount>& map) = 0;
  virtual void loadTransactions(const QMap<QCString, MyMoneyTransaction>& map) = 0;
  virtual void loadInstitutions(const QMap<QCString, MyMoneyInstitution>& map) = 0;
  virtual void loadPayees(const QMap<QCString, MyMoneyPayee>& map) = 0;
  virtual void loadSchedules(const QMap<QCString, MyMoneySchedule>& map) = 0;
  virtual void loadSecurities(const QMap<QCString, MyMoneySecurity>& map) = 0;
  virtual void loadCurrencies(const QMap<QCString, MyMoneySecurity>& map) = 0;
  virtual void loadReports( const QMap<QCString, MyMoneyReport>& reports ) = 0;
  virtual void loadBudgets( const QMap<QCString, 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<QCString, QString> pairs(void) const = 0;

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

  virtual const QValueList<MyMoneySchedule> scheduleListEx( int scheduleTypes,
                                              int scheduleOcurrences,
                                              int schedulePaymentTypes,
                                              QDate startDate,
                                              const QCStringList& accounts=QCStringList()) 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;

};

#endif

---