---

transaction.h

Go to the documentation of this file.

/***************************************************************************
 $RCSfile: transaction.h,v $
                             -------------------
    cvs         : $Id: transaction.h,v 1.10 2003/06/14 11:06:23 aquamaniac Exp $
    begin       : Sat Jun 08 2002
    copyright   : (C) 2002 by Martin Preuss
    email       : openhbci@aquamaniac.de

 ***************************************************************************
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef HBCITRANSACTION_H
#define HBCITRANSACTION_H

#include <openhbci/dllimport.h>
#include <openhbci/date.h>
#include <openhbci/value.h>
#include <openhbci/hbcistringlist.h>
#include <openhbci/abstracttrans.h>

#ifdef __cplusplus
#include <string>
#include <list>

namespace HBCI {

class DLLIMPORT Transaction : AbstractTrans {
private:
  unsigned int _tid;
  int _ourCountryCode;
  string _ourInstCode;
  string _ourId;
  string _ourSuffix;
  int _otherCountryCode;
  string _otherInstCode;
  string _otherId;
  string _otherSuffix;
  list<string> _otherName;
  string _primanota;
  string _transactionKey;
  string _customerReference;
  string _bankReference;
  int _transactionCode;
  list<string> _description;
  string _transactionText;
  Date _date;
  Date _valutaDate;
  Value _value;
  Value _originalValue;
  Value _charge;

public:
  Transaction();
  virtual ~Transaction();

  virtual unsigned int id() const { return _tid;};
  virtual void setId(unsigned int i) { _tid=i;};
  int ourCountryCode() const { return _ourCountryCode;};
  void setOurCountryCode(int i) { _ourCountryCode=i;};

  const string &ourBankCode() const { return _ourInstCode;};
  void setOurBankCode(const string &code) { _ourInstCode=code;};

  const string &ourAccountId() const { return _ourId;};
  void setOurAccountId(const string &id) { _ourId=id;};

  const string &ourSuffix() const { return _ourSuffix;};
  void setOurSuffix(const string &id) { _ourSuffix=id;};
  const Date &valutaDate() const { return _valutaDate;};
  void setValutaDate(const Date &d) { _valutaDate=d;};

  const Date &date() const {return _date;};
  void setDate(const Date &d) { _date=d;};
  const Value &value() const { return _value;};
  void setValue(const Value &v) { _value=v;};
  const string &transactionKey() const { return _transactionKey;};
  void setTransactionKey(const string &s) { _transactionKey=s;};
  const string &customerReference() const { return _customerReference; };
  void setCustomerReference(const string &s) { _customerReference=s;};

  const string &bankReference() const { return _bankReference; };
  void setBankReference(const string &s) { _bankReference=s;};
  const Value &originalValue() const { return _originalValue;};
  void setOriginalValue(const Value &v) { _originalValue=v;};

  const Value &charge() const { return _charge;};
  void setCharge(const Value &v) { _charge=v;};
  /* Now follows the obnoxious "Mehrzweckfeld :86:" */

  int transactionCode() const { return _transactionCode;};
  void setTransactionCode(int c) { _transactionCode=c;};

  const string &transactionText() const { return _transactionText;};
  void setTransactionText(const string &s) { _transactionText=s;};

  const string &primanota() const { return _primanota;};
  void setPrimanota(const string &s) { _primanota=s;};

  const list<string> &description() const { return _description;};
  void addDescription(const string &s) { _description.push_back(s);};
  int otherCountryCode() const { return _otherCountryCode;};
  void setOtherCountryCode(int i) { _otherCountryCode=i;};

  const string &otherBankCode() const { return _otherInstCode;};
  void setOtherBankCode(const string &s) { _otherInstCode=s;};

  const string &otherAccountId() const { return _otherId;};
  void setOtherAccountId(const string &s) { _otherId=s;};

  const string &otherSuffix() const { return _otherSuffix;};
  void setOtherSuffix(const string &id) { _otherSuffix=id;};

  const list<string> &otherName() const { return _otherName;};
  void addOtherName(const string &s) { _otherName.push_back(s);};
  bool operator==(const Transaction &tda) const;

};

} /* namespace HBCI */

typedef struct HBCI::Transaction HBCI_Transaction;
/* for C wrapper functions */
typedef list<HBCI::Transaction> list_HBCI_Transaction;
typedef list<HBCI::Transaction>::const_iterator list_HBCI_Transaction_iter;

extern "C" {    
#else /* __cplusplus */
typedef struct HBCI_Transaction HBCI_Transaction;
typedef struct list_HBCI_Transaction list_HBCI_Transaction;
typedef struct list_HBCI_Transaction_iter list_HBCI_Transaction_iter;
#endif /* __cplusplus */

    extern HBCI_Transaction * HBCI_Transaction_new();
    extern void HBCI_Transaction_delete(HBCI_Transaction *t);

    extern int HBCI_Transaction_ourCountryCode(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOurCountryCode(HBCI_Transaction *t, int i);

    extern const char * 
    HBCI_Transaction_ourBankCode(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOurBankCode(HBCI_Transaction *t, const char *code);

    extern const char * 
    HBCI_Transaction_ourAccountId(const HBCI_Transaction *t);
    extern void 
        HBCI_Transaction_setOurAccountId(HBCI_Transaction *t, const char *id);

    extern const char * 
    HBCI_Transaction_ourSuffix(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOurSuffix(HBCI_Transaction *t, const char *id);
    extern const HBCI_Date* 
    HBCI_Transaction_valutaDate(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setValutaDate(HBCI_Transaction *t, const HBCI_Date *d);

    extern const HBCI_Date* 
    HBCI_Transaction_date(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setDate(HBCI_Transaction *t, const HBCI_Date *d);
    extern const HBCI_Value* 
    HBCI_Transaction_value(const HBCI_Transaction *t);

    extern void 
    HBCI_Transaction_setValue(HBCI_Transaction *t, const HBCI_Value *v);
    extern const char * 
    HBCI_Transaction_transactionKey(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setTransactionKey(HBCI_Transaction *t, const char *s);
    /* Reference char *, if the customer (you) has specified
     * one. (E.g. the cheque number.) Otherwise "NONREF". --
     * Kundenreferenz in :61: */
    extern const char * 
    HBCI_Transaction_customerReference(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setCustomerReference(HBCI_Transaction *t, const char *s);
 
    /* Reference char * for this transaction given by the bank, if it
     * has given one. Otherwise empty. -- Bankreferenz in :61: */
    extern const char * 
    HBCI_Transaction_bankReference(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setBankReference(HBCI_Transaction *t, const char *s);
    /* Now follows the obnoxious "Mehrzweckfeld :86:" */

    extern int HBCI_Transaction_transactionCode(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setTransactionCode(HBCI_Transaction *t, int c);

    extern const char * 
    HBCI_Transaction_transactionText(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setTransactionText(HBCI_Transaction *t, const char *s);

    extern const char * 
    HBCI_Transaction_primanota(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setPrimanota(HBCI_Transaction *t, const char *s);

    extern const list_string* 
    HBCI_Transaction_description(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_addDescription(HBCI_Transaction *t, const char *s);
    extern int 
    HBCI_Transaction_otherCountryCode(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOtherCountryCode(HBCI_Transaction *t, int i);

    extern const char * 
    HBCI_Transaction_otherBankCode(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOtherBankCode(HBCI_Transaction *t, const char *s);

    extern const char * 
    HBCI_Transaction_otherAccountId(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOtherAccountId(HBCI_Transaction *t, const char *s);

    extern const char * 
    HBCI_Transaction_otherSuffix(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_setOtherSuffix(HBCI_Transaction *t, const char *id);

    extern const list_string* 
    HBCI_Transaction_otherName(const HBCI_Transaction *t);
    extern void 
    HBCI_Transaction_addOtherName(HBCI_Transaction *t, const char *s);
    extern void list_HBCI_Transaction_delete(list_HBCI_Transaction *l);
    extern void 
    list_HBCI_Transaction_iter_delete(list_HBCI_Transaction_iter *l);
    extern int list_HBCI_Transaction_size(const list_HBCI_Transaction *l);
    extern list_HBCI_Transaction_iter* 
    list_HBCI_Transaction_begin(const list_HBCI_Transaction *l);
    extern list_HBCI_Transaction_iter* 
    list_HBCI_Transaction_end(const list_HBCI_Transaction *l);
    extern const HBCI_Transaction* 
    list_HBCI_Transaction_iter_get(const list_HBCI_Transaction_iter *l);
    extern void
    list_HBCI_Transaction_iter_next(list_HBCI_Transaction_iter *l);
    extern int 
    list_HBCI_Transaction_iter_equal(const list_HBCI_Transaction_iter *l1, 
                                    const list_HBCI_Transaction_iter *l2);
    typedef void *(*list_HBCI_Transaction_cb) (const HBCI_Transaction *trans, 
                                               void *user_data);
    extern void *
    list_HBCI_Transaction_foreach (const list_HBCI_Transaction *list, 
                                   list_HBCI_Transaction_cb func,
                                   void *user_data);
#ifdef __cplusplus
}

#endif


#endif

---