Added kmymoney

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kmymoney@1239792 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 692 insertions, 0 deletions

diff --git a/kmymoney2/mymoney/mymoneyaccount.h b/kmymoney2/mymoney/mymoneyaccount.h
new file mode 100644
index 0000000..333c500
--- /dev/null
+++ b/kmymoney2/mymoney/mymoneyaccount.h
@@ -0,0 +1,692 @@
+/***************************************************************************
+                          mymoneyaccount.h
+                          -------------------
+    copyright            : (C) 2002 by Thomas Baumgart
+    email                : [email protected]
+ ***************************************************************************/
+
+/***************************************************************************
+ *                                                                         *
+ *   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/export.h>
+#include "mymoneyutils.h"
+class MyMoneyTransaction;
+class MyMoneyInstitution;
+class MyMoneySplit;
+class MyMoneyObjectContainer;
+
+/**
+  * A representation of an account.
+  * This object represents any type of account, those held at an
+  * institution as well as the accounts used for double entry
+  * accounting.
+  *
+  * Currently, the following account types are known:
+  *
+  * @li  UnknownAccountType
+  * @li  Checkings
+  * @li  Savings
+  * @li  Cash
+  * @li  CreditCard
+  * @li  Loan (collected)
+  * @li  CertificateDep
+  * @li  Investment
+  * @li  MoneyMarket
+  * @li  Currency
+  * @li  Asset
+  * @li  Liability
+  * @li  Income
+  * @li  Expense
+  * @li  Loan (given)
+  * @li  Equity
+  *
+  * @see MyMoneyInstitution
+  * @see MyMoneyFile
+  *
+  * @author Michael Edwardes 2000-2001
+  * @author Thomas Baumgart 2002
+  *
+**/
+class KMYMONEY_EXPORT MyMoneyAccount : public MyMoneyObject, public MyMoneyKeyValueContainer
+{
+  friend class MyMoneyObjectContainer;
+public:
+
+  /**
+    * Account types currently supported.
+    */
+  typedef enum _accountTypeE {
+    UnknownAccountType=0, /**< For error handling */
+    Checkings,            /**< Standard checking account */
+    Savings,              /**< Typical savings account */
+    Cash,                 /**< Denotes a shoe-box or pillowcase stuffed
+                               with cash */
+    CreditCard,           /**< Credit card accounts */
+    Loan,                 /**< Loan and mortgage accounts (liability) */
+    CertificateDep,       /**< Certificates of Deposit */
+    Investment,           /**< Investment account */
+    MoneyMarket,          /**< Money Market Account */
+    Asset,                /**< Denotes a generic asset account.*/
+    Liability,            /**< Denotes a generic liability account.*/
+    Currency,             /**< Denotes a currency trading account. */
+    Income,               /**< Denotes an income account */
+    Expense,              /**< Denotes an expense account */
+    AssetLoan,            /**< Denotes a loan (asset of the owner of this object) */
+    Stock,                /**< Denotes an security account as sub-account for an investment */
+    Equity,               /**< Denotes an equity account e.g. opening/closeing balance */
+
+    /* insert new account types above this line */
+    MaxAccountTypes       /**< Denotes the number of different account types */
+  }accountTypeE;
+
+  /**
+    * This is the constructor for a new empty account
+    */
+  MyMoneyAccount();
+
+  /**
+    * This is the constructor for a new account known to the current file
+    * This is the only constructor that will set the attribute m_openingDate
+    * to a correct value.
+    *
+    * @param id id assigned to the account
+    * @param right account definition
+    */
+  MyMoneyAccount(const QString& id, const MyMoneyAccount& right);
+
+  /**
+    * This is the constructor for an account that is described by a
+    * QDomElement (e.g. from a file).
+    *
+    * @param el const reference to the QDomElement from which to
+    *           create the object
+    */
+  MyMoneyAccount(const QDomElement& el);
+
+  /**
+    * This is the destructor for any MyMoneyAccount object
+    */
+  ~MyMoneyAccount();
+
+  /**
+    * This operator tests for equality of two MyMoneyAccount objects
+    */
+  bool operator == (const MyMoneyAccount &) const;
+
+  /**
+    * This converts the account type into one of the four
+    * major account types liability, asset, expense or income.
+    *
+    * The current assignment is as follows:
+    *
+    * - Asset
+    *   - Asset
+    *   - Checkings
+    *   - Savings
+    *   - Cash
+    *   - Currency
+    *   - Investment
+    *   - MoneyMarket
+    *   - CertificateDep
+    *   - AssetLoan
+    *   - Stock
+    *
+    * - Liability
+    *   - Liability
+    *   - CreditCard
+    *   - Loan
+    *
+    * - Income
+    *   - Income
+    *
+    * - Expense
+    *   - Expense
+    *
+    * @param type actual account type
+    * @return accountTypeE of major account type
+    */
+  static MyMoneyAccount::accountTypeE accountGroup(MyMoneyAccount::accountTypeE type);
+
+  MyMoneyAccount::accountTypeE accountGroup(void) const;
+
+  /**
+    * This method returns the id of the MyMoneyInstitution object this account
+    * belongs to.
+    * @return id of MyMoneyInstitution object. QString() if it is
+    *         an internal account
+    * @see setInstitution
+    */
+  const QString& institutionId(void) const { return m_institution; }
+
+  /**
+    * This method returns the name of the account
+    * @return name of account
+    * @see setName()
+    */
+  const QString& name(void) const { return m_name; }
+
+  /**
+    * This method returns the number of the account at the institution
+    * @return number of account at the institution
+    * @see setNumber
+    */
+  const QString& number(void) const { return m_number; }
+
+  /**
+    * This method returns the descriptive text of the account.
+    * @return description of account
+    * @see setDescription
+    */
+  const QString& description(void) const { return m_description; }
+
+  /**
+    * This method returns the opening date of this account
+    * @return date of opening of this account as const QDate value
+    * @see setOpeningDate()
+    */
+  const QDate& openingDate(void) const { return m_openingDate; }
+
+  /**
+    * This method returns the date of the last reconciliation of this account
+    * @return date of last reconciliation as const QDate value
+    * @see setLastReconciliationDate
+    */
+  const QDate& lastReconciliationDate(void) const { return m_lastReconciliationDate; }
+
+  /**
+    * This method returns the date the account was last modified
+    * @return date of last modification as const QDate value
+    * @see setLastModified
+    */
+  const QDate& lastModified(void) const { return m_lastModified; }
+
+  /**
+    * This method is used to return the ID of the parent account
+    * @return QString with the ID of the parent of this account
+    */
+  const QString& parentAccountId(void) const { return m_parentAccount; };
+
+  /**
+    * This method returns the list of the account id's of
+    * subordinate accounts
+    * @return QStringList account ids
+    */
+  const QStringList& accountList(void) const { return m_accountList; };
+
+  /**
+    * This method returns the number of entries in the m_accountList
+    * @return number of entries in the accountList
+    */
+  int accountCount(void) const { return m_accountList.count(); };
+
+  /**
+    * This method is used to add an account id as sub-ordinate account
+    * @param account const QString reference to account ID
+    */
+  void addAccountId(const QString& account);
+
+  /**
+    * This method is used to remove an account from the list of
+    * sub-ordinate accounts.
+    * @param account const QString reference to account ID to be removed
+    */
+  void removeAccountId(const QString& account);
+
+  /**
+    * This method is used to remove all accounts from the list of
+    * sub-ordinate accounts.
+    */
+  void removeAccountIds(void);
+
+  /**
+    * This method is used to modify the date of the last
+    * modification access.
+    * @param date date of last modification
+    * @see lastModified
+    */
+  void setLastModified(const QDate& date);
+
+  /**
+    * This method is used to set the name of the account
+    * @param name name of the account
+    * @see name
+    */
+  void setName(const QString& name);
+
+  /**
+    * This method is used to set the number of the account at the institution
+    * @param number number of the account
+    * @see number
+    */
+  void setNumber(const QString& number);
+
+  /**
+    * This method is used to set the descriptive text of the account
+    *
+    * @param desc text that serves as description
+    * @see setDescription
+    */
+  void setDescription(const QString& desc);
+
+  /**
+    * This method is used to set the id of the institution this account
+    * belongs to.
+    *
+    * @param id id of the institution this account belongs to
+    * @see institution
+    */
+  void setInstitutionId(const QString& id);
+
+  /**
+    * This method is used to set the opening date information of an
+    * account.
+    *
+    * @param date QDate of opening date
+    * @see openingDate
+    */
+  void setOpeningDate(const QDate& date);
+
+  /**
+    * This method is used to set the date of the last reconciliation
+    * of an account.
+    * @param date QDate of last reconciliation
+    * @see lastReconciliationDate
+    */
+  void setLastReconciliationDate(const QDate& date);
+
+  /**
+    * This method is used to change the account type
+    *
+    * @param type account type
+    */
+  void setAccountType(const accountTypeE type);
+
+  /**
+    * This method is used to set a new parent account id
+    * @param parent QString reference to new parent account
+    */
+  void setParentAccountId(const QString& parent);
+
+  /**
+    * This method is used to update m_lastModified to the current date
+    */
+  void touch(void) { setLastModified(QDate::currentDate()); }
+
+  /**
+    * This method returns the type of the account.
+    */
+  accountTypeE accountType(void) const { return m_accountType; }
+
+  /**
+    * This method retrieves the id of the currency used with this account.
+    * If the return value is empty, the base currency should be used.
+    *
+    * @return id of currency
+    */
+  const QString& currencyId(void) const { return m_currencyId; };
+
+  /**
+    * This method sets the id of the currency used with this account.
+    *
+    * @param id ID of currency to be associated with this account.
+    */
+  void setCurrencyId(const QString& id);
+
+  void writeXML(QDomDocument& document, QDomElement& parent) const;
+
+  /**
+    * This method checks if a reference to the given object exists. It returns,
+    * a @p true if the object is referencing the one requested by the
+    * parameter @p id. If it does not, this method returns @p false.
+    *
+    * @param id id of the object to be checked for references
+    * @retval true This object references object with id @p id.
+    * @retval false This object does not reference the object with id @p id.
+    */
+  virtual bool hasReferenceTo(const QString& id) const;
+
+  /**
+    * This member returns the balance of this account based on
+    * all transactions stored in the journal.
+    */
+  const MyMoneyMoney& balance(void) const { return m_balance; }
+
+  /**
+    * This method adjusts the balance of this account
+    * according to the difference contained in the split @p s.
+    * If the s.action() is MyMoneySplit::ActionSplitShares then
+    * the balance will be adjusted accordingly.
+    *
+    * @param s const reference to MyMoneySplit object containing the
+    *             value to be added/subtracted to/from the balance
+    * @param reverse add (false) or subtract (true) the shares contained in the split.
+    *          It also affects the balance for share splits in the opposite direction.
+    */
+  void adjustBalance(const MyMoneySplit& s, bool reverse = false);
+
+  /**
+    * This method sets the balance of this account
+    * according to the value provided by @p val.
+    *
+    * @param val const reference to MyMoneyMoney object containing the
+    *             value to be assigned to the balance
+    */
+  void setBalance(const MyMoneyMoney& val) { m_balance = val; }
+
+  /**
+    * This method sets the kvp's for online banking with this account
+    *
+    * @param values The container of kvp's needed when connecting to this account
+    */
+  void setOnlineBankingSettings(const MyMoneyKeyValueContainer& values);
+
+  /**
+    * This method retrieves the kvp's for online banking with this account
+    *
+    * @return The container of kvp's needed when connecting to this account
+    */
+  const MyMoneyKeyValueContainer& onlineBankingSettings(void) const;
+
+  /**
+    * This method sets the closed flag for the account. This is just
+    * an informational flag for the application. It has no other influence
+    * on the behaviour of the account object. The default for
+    * new objects @p open.
+    *
+    * @param isClosed mark the account closed (@p true) or open (@p false).
+    */
+  void setClosed(bool isClosed);
+
+  /**
+    * Return the closed flag for the account.
+    *
+    * @retval false account is marked open (the default for new accounts)
+    * @retval true account is marked closed
+    */
+  bool isClosed(void) const;
+
+  /**
+    * returns the applicable smallest fraction for this account
+    * for the given security based on the account type. At the same
+    * time, m_fraction is updated to the value returned.
+    *
+    * @param sec const reference to currency (security)
+    *
+    * @retval sec.smallestCashFraction() for account type Cash
+    * @retval sec.smallestAccountFraction() for all other account types
+    */
+  int fraction(const MyMoneySecurity& sec);
+
+  /**
+   * Same as the above method, but does not modify m_fraction.
+   */
+  int fraction(const MyMoneySecurity& sec) const;
+
+  /**
+    * This method returns the stored value for the fraction of this
+    * account or -1 if not initialized. It can be initialized by
+    * calling fraction(const MyMoneySecurity& sec) once.
+    *
+    * @note Don't use this method outside of KMyMoney application context (eg. testcases).
+    * Use the above method instead.
+    */
+  int fraction(void) const;
+
+  /**
+    * This method returns @a true if the account type is
+    * either Income or Expense
+    *
+    * @retval true account is of type income or expense
+    * @retval false for all other account types
+    *
+    * @deprecated use isIncomeExpense() instead
+    */
+  bool isCategory(void) const __attribute__ ((deprecated));
+
+  /**
+    * This method returns @a true if the account type is
+    * either Income or Expense
+    *
+    * @retval true account is of type income or expense
+    * @retval false for all other account types
+    */
+  bool isIncomeExpense(void) const;
+
+  /**
+    * This method returns @a true if the account type is
+    * either Asset or Liability
+    *
+    * @retval true account is of type asset or liability
+    * @retval false for all other account types
+    */
+  bool isAssetLiability(void) const;
+
+  /**
+    * This method returns @a true if the account type is
+    * either AssetLoan or Loan
+    *
+    * @retval true account is of type Loan or AssetLoan
+    * @retval false for all other account types
+    */
+  bool isLoan(void) const;
+
+  /**
+    * This method returns @a true if the account type is
+    * Stock
+    *
+    * @retval true account is of type Stock
+    * @retval false for all other account types
+    */
+  bool isInvest(void) const;
+
+  /**
+   * This method returns a name that has a brokerage suffix of
+   * the current name. It only works on investment accounts and
+   * returns the name for all other cases.
+   */
+  QString brokerageName(void) const;
+
+  /**
+   * @param size is a hint for the size of the icon
+   * @return a pixmap using DesktopIcon for the account type
+   */
+  QPixmap accountPixmap(bool reconcileFlag = false, int size = 0) const;
+
+  /**
+   * This method is used to convert the internal representation of
+   * an account type into a human readable format
+   *
+   * @param accountType numerical representation of the account type.
+   *                    For possible values, see MyMoneyAccount::accountTypeE
+   * @return QString representing the human readable form
+   */
+  static QString accountTypeToString(const MyMoneyAccount::accountTypeE accountType);
+
+  KMYMONEY_EXPORT QDataStream &operator<<( const MyMoneyAccount & );
+  KMYMONEY_EXPORT QDataStream &operator>>( MyMoneyAccount & );
+
+private:
+  /**
+    * This member variable identifies the type of account
+    */
+  accountTypeE m_accountType;
+
+  /**
+    * This member variable keeps the ID of the MyMoneyInstitution object
+    * that this object belongs to.
+    */
+  QString m_institution;
+
+  /**
+    * This member variable keeps the name of the account
+    * It is solely for documentation purposes and it's contents is not
+    * used otherwise by the mymoney-engine.
+    */
+  QString m_name;
+
+  /**
+    * This member variable keeps the account number at the institution
+    * It is solely for documentation purposes and it's contents is not
+    * used otherwise by the mymoney-engine.
+    */
+  QString m_number;
+
+  /**
+    * This member variable is a description of the account.
+    * It is solely for documentation purposes and it's contents is not
+    * used otherwise by the mymoney-engine.
+    */
+  QString m_description;
+
+  /**
+    * This member variable keeps the date when the account
+    * was last modified.
+    */
+  QDate m_lastModified;
+
+  /**
+    * This member variable keeps the date when the
+    * account was created as an object in a MyMoneyFile
+    */
+  QDate m_openingDate;
+
+  /**
+    * This member variable keeps the date of the last
+    * reconciliation of this account
+    */
+  QDate m_lastReconciliationDate;
+
+  /**
+    * This member holds the ID's of all sub-ordinate accounts
+    */
+  QStringList m_accountList;
+
+  /**
+    * This member contains the ID of the parent account
+    */
+  QString m_parentAccount;
+
+  /**
+    * This member contains the ID of the currency associated with this account
+    */
+  QString m_currencyId;
+
+  /**
+    * This member holds the balance of all transactions stored in the journal
+    * for this account.
+    */
+  MyMoneyMoney    m_balance;
+
+  /**
+    * This member variable keeps the set of kvp's needed to establish
+    * online banking sessions to this account.
+    */
+  MyMoneyKeyValueContainer m_onlineBankingSettings;
+
+  /**
+    * This member keeps the fraction for the account. It is filled by MyMoneyFile
+    * when set to -1. See also @sa fraction(const MyMoneySecurity&).
+    */
+  int             m_fraction;
+
+};
+
+/**
+  * This class is a convenience class to access data for loan accounts.
+  * It does contain the same member variables as a MyMoneyAccount object,
+  * but serves a set of getter/setter methods to ease the access to
+  * laon relevant data stored in the key value container of the MyMoneyAccount
+  * object.
+  */
+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);
+
+  /**
+    * This method checks if a reference to the given object exists. It returns,
+    * a @p true if the object is referencing the one requested by the
+    * parameter @p id. If it does not, this method returns @p false.
+    *
+    * @param id id of the object to be checked for references
+    * @retval true This object references object with id @p id.
+    * @retval false This object does not reference the object with id @p id.
+    */
+  virtual bool hasReferenceTo(const QString& id) const;
+
+};
+
+#endif
+
+