mymoneyaccount.h

Go to the documentation of this file.

/***************************************************************************
                          mymoneyaccount.h
                          -------------------
    copyright            : (C) 2002 by Thomas Baumgart
    email                : ipwizard@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 MYMONEYACCOUNT_H
#define MYMONEYACCOUNT_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

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

#include <qstring.h>
#include <qdatetime.h>
#include <qvaluelist.h>
#include <qstringlist.h>
#include <qdom.h>
#include <qpixmap.h>

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

#include <kmymoney/mymoneymoney.h>
#include <kmymoney/mymoneyobject.h>
#include <kmymoney/mymoneykeyvaluecontainer.h>
#include <kmymoney/mymoneysecurity.h>
#include <kmymoney/mymoneytransaction.h>
#include <kmymoney/export.h>
#include "mymoneyutils.h"
class MyMoneyTransaction;
class MyMoneyInstitution;
class MyMoneySplit;
class MyMoneyObjectContainer;

class KMYMONEY_EXPORT MyMoneyAccount : public MyMoneyObject, public MyMoneyKeyValueContainer
{
  friend class MyMoneyObjectContainer;
public:

  typedef enum _accountTypeE {
    UnknownAccountType=0, 
    Checkings,            
    Savings,              
    Cash,                 
    CreditCard,           
    Loan,                 
    CertificateDep,       
    Investment,           
    MoneyMarket,          
    Asset,                
    Liability,            
    Currency,             
    Income,               
    Expense,              
    AssetLoan,            
    Stock,                
    Equity,               
    /* insert new account types above this line */
    MaxAccountTypes       
  }accountTypeE;

  MyMoneyAccount();

  MyMoneyAccount(const QString& id, const MyMoneyAccount& right);

  MyMoneyAccount(const QDomElement& el);

  ~MyMoneyAccount();

  bool operator == (const MyMoneyAccount &) const;

  static MyMoneyAccount::accountTypeE accountGroup(MyMoneyAccount::accountTypeE type);

  MyMoneyAccount::accountTypeE accountGroup(void) const;

  const QString& institutionId(void) const { return m_institution; }

  const QString& name(void) const { return m_name; }

  const QString& number(void) const { return m_number; }

  const QString& description(void) const { return m_description; }

  const QDate& openingDate(void) const { return m_openingDate; }

  const QDate& lastReconciliationDate(void) const { return m_lastReconciliationDate; }

  const QDate& lastModified(void) const { return m_lastModified; }

  const QString& parentAccountId(void) const { return m_parentAccount; };

  const QStringList& accountList(void) const { return m_accountList; };

  int accountCount(void) const { return m_accountList.count(); };

  void addAccountId(const QString& account);

  void removeAccountId(const QString& account);

  void removeAccountIds(void);

  void setLastModified(const QDate& date);

  void setName(const QString& name);

  void setNumber(const QString& number);

  void setDescription(const QString& desc);

  void setInstitutionId(const QString& id);

  void setOpeningDate(const QDate& date);

  void setLastReconciliationDate(const QDate& date);

  void setAccountType(const accountTypeE type);

  void setParentAccountId(const QString& parent);

  void touch(void) { setLastModified(QDate::currentDate()); }

  accountTypeE accountType(void) const { return m_accountType; }

  const QString& currencyId(void) const { return m_currencyId; };

  void setCurrencyId(const QString& id);

  void writeXML(QDomDocument& document, QDomElement& parent) const;

  virtual bool hasReferenceTo(const QString& id) const;

  const MyMoneyMoney& balance(void) const { return m_balance; }

  void adjustBalance(const MyMoneySplit& s, bool reverse = false);

  void setBalance(const MyMoneyMoney& val) { m_balance = val; }

  void setOnlineBankingSettings(const MyMoneyKeyValueContainer& values);

  const MyMoneyKeyValueContainer& onlineBankingSettings(void) const;

  void setClosed(bool isClosed);

  bool isClosed(void) const;

  int fraction(const MyMoneySecurity& sec);

  int fraction(const MyMoneySecurity& sec) const;

  int fraction(void) const;

  bool isCategory(void) const __attribute__ ((deprecated));

  bool isIncomeExpense(void) const;

  bool isAssetLiability(void) const;

  bool isLoan(void) const;

  bool isInvest(void) const;

  QString brokerageName(void) const;

  QPixmap accountPixmap(bool reconcileFlag = false, int size = 0) const;

  static QString accountTypeToString(const MyMoneyAccount::accountTypeE accountType);

  KMYMONEY_EXPORT QDataStream &operator<<( const MyMoneyAccount & );
  KMYMONEY_EXPORT QDataStream &operator>>( MyMoneyAccount & );

private:
  accountTypeE m_accountType;

  QString m_institution;

  QString m_name;

  QString m_number;

  QString m_description;

  QDate m_lastModified;

  QDate m_openingDate;

  QDate m_lastReconciliationDate;

  QStringList m_accountList;

  QString m_parentAccount;

  QString m_currencyId;

  MyMoneyMoney    m_balance;

  MyMoneyKeyValueContainer m_onlineBankingSettings;

  int             m_fraction;

};

class KMYMONEY_EXPORT MyMoneyAccountLoan : public MyMoneyAccount
{
public:
  enum interestDueE {
    paymentDue = 0,
    paymentReceived
  };

  enum interestChangeUnitE {
    changeDaily = 0,
    changeWeekly,
    changeMonthly,
    changeYearly
  };

  MyMoneyAccountLoan() {}
  MyMoneyAccountLoan(const MyMoneyAccount&);
  ~MyMoneyAccountLoan() {}

  const MyMoneyMoney loanAmount(void) const;
  void setLoanAmount(const MyMoneyMoney& amount);
  const MyMoneyMoney interestRate(const QDate& date) const;
  void setInterestRate(const QDate& date, const MyMoneyMoney& rate);
  interestDueE interestCalculation(void) const;
  void setInterestCalculation(const interestDueE onReception);
  const QDate nextInterestChange(void) const;
  void setNextInterestChange(const QDate& date);
  const QString schedule(void) const;
  void setSchedule(const QString& sched);
  bool fixedInterestRate(void) const;
  void setFixedInterestRate(const bool fixed);
  const MyMoneyMoney finalPayment(void) const;
  void setFinalPayment(const MyMoneyMoney& finalPayment);
  unsigned int term(void) const;
  void setTerm(const unsigned int payments);
  int interestChangeFrequency(int* unit = 0) const;
  void setInterestChangeFrequency(const int amount, const int unit);
  const MyMoneyMoney periodicPayment(void) const;
  void setPeriodicPayment(const MyMoneyMoney& payment);
  int interestCompounding(void) const;
  void setInterestCompounding(int frequency);
  const QString payee(void) const;
  void setPayee(const QString& payee);
  const QString interestAccountId(void) const;
  void setInterestAccountId(const QString& id);

  virtual bool hasReferenceTo(const QString& id) const;

};

#endif