mymoneytransaction.h

Go to the documentation of this file.

/***************************************************************************
                          mymoneytransaction.h
                             -------------------
    copyright            : (C) 2000 by Michael Edwardes
                           (C) 2002 by Thomas Baumgart
    email                : mte@users.sourceforge.net
                           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 MYMONEYTRANSACTION_H
#define MYMONEYTRANSACTION_H

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

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

#include <qstring.h>
#include <qdatetime.h>
#include <qptrlist.h>
#include <qstringlist.h>

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

#include "mymoneyutils.h"
#include "mymoneymoney.h"
#include "mymoneykeyvaluecontainer.h"
#include "mymoneysplit.h"
#include <kmymoney/export.h>

class KMYMONEY_EXPORT MyMoneyTransaction : public MyMoneyObject, public MyMoneyKeyValueContainer
{
public:
  MyMoneyTransaction();
  MyMoneyTransaction(const QString id,
                             const MyMoneyTransaction& transaction);
  MyMoneyTransaction(const QDomElement& node, const bool forceId = true);
  ~MyMoneyTransaction();

public:
  friend QDataStream &operator<<(QDataStream &, MyMoneyTransaction &);
  friend QDataStream &operator>>(QDataStream &, MyMoneyTransaction &);

  // Simple get operations
  const QDate& entryDate(void) const { return m_entryDate; };
  const QDate& postDate(void) const { return m_postDate; };
  const QString& memo(void) const { return m_memo; };
  const QValueList<MyMoneySplit>& splits(void) const { return m_splits; };
  QValueList<MyMoneySplit>& splits(void) { return m_splits; };
  unsigned int splitCount(void) const { return m_splits.count(); };
  const QString& commodity(void) const { return m_commodity; };
  const QString& bankID(void) const /*__attribute__ ((deprecated))*/ { return m_bankID; };

  // Simple set operations
  void setPostDate(const QDate& date);
  void setEntryDate(const QDate& date);
  void setMemo(const QString& memo);
  void setCommodity(const QString& commodityId) { m_commodity = commodityId; };
  void setBankID(const QString& bankID) /*__attribute__ ((deprecated))*/ { m_bankID = bankID; };

  bool operator == (const MyMoneyTransaction&) const;
  inline bool operator != (const MyMoneyTransaction& r) const { return !(*this == r); };
  bool operator< (const MyMoneyTransaction& r) const { return postDate() < r.postDate(); };
  bool operator<= (const MyMoneyTransaction& r) const { return postDate() <= r.postDate(); };
  bool operator> (const MyMoneyTransaction& r) const { return postDate() > r.postDate(); };

  const MyMoneySplit& splitByAccount(const QString& accountId, const bool match = true) const;

  const MyMoneySplit& splitByAccount(const QStringList& accountIds, const bool match = true) const;

  const MyMoneySplit& splitById(const QString& splitId) const;

  const MyMoneySplit& splitByPayee(const QString& payeeId) const;

  bool accountReferenced(const QString& id) const;

  void addSplit(MyMoneySplit& split);

  void modifySplit(MyMoneySplit& split);

  void removeSplit(const MyMoneySplit& split);

  void removeSplits(void);

  const MyMoneyMoney splitSum(void) const;

  bool isLoanPayment(void) const;

  const MyMoneySplit& amortizationSplit(void) const;

  const MyMoneySplit& interestSplit(void) const;

  bool isDuplicate(const MyMoneyTransaction& transaction) const;

  bool isStockSplit(void) const;

  bool isImported(void) const;

  void setImported(bool state = true);

  static const QString firstSplitID(void);

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

  virtual bool hasReferenceTo(const QString& id) const;

  bool hasAutoCalcSplit(void) const;

  QString accountSignature(bool includeSplitCount = false) const;

  QString uniqueSortKey(void) const;

  static unsigned long hash(const QString& txt, unsigned long h = 0);

private:
  const QString nextSplitID(void);

private:
  static const int SPLIT_ID_SIZE = 4;

  QDate m_entryDate;

  QDate m_postDate;

  QString m_memo;

  QValueList<MyMoneySplit> m_splits;

  unsigned int m_nextSplitID;

  QString  m_commodity;

  QString m_bankID;

  static const int YEAR_SIZE = 4;
  static const int MONTH_SIZE = 2;
  static const int DAY_SIZE = 2;
};
#endif