---

standingorder.h

Go to the documentation of this file.

/***************************************************************************
 $RCSfile: standingorder.h,v $
 -------------------
 cvs         : $Id: standingorder.h,v 1.11 2003/04/15 22:10:23 cstim Exp $
 begin       : Mon Jun 17 2002
 copyright   : (C) 2002 by Fabian Kaiser
 email       : openhbci@derzach.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 HBCI_STANDINGORDER_H
#define HBCI_STANDINGORDER_H

#ifdef __cplusplus
#include <list>
#include <string>
#include <openhbci/pointer.h>
using namespace std;

namespace HBCI {
  class StandingOrder;
}
/* for C wrapper functions */
typedef struct HBCI::StandingOrder HBCI_StandingOrder;
typedef list<HBCI::Pointer<HBCI::StandingOrder> > list_HBCI_StO;
typedef list<HBCI::Pointer<HBCI::StandingOrder> >::const_iterator 
   list_HBCI_StO_iter;
#else /* __cplusplus */
typedef struct HBCI_StandingOrder HBCI_StandingOrder;
typedef struct list_HBCI_StO list_HBCI_StO;
typedef struct list_HBCI_StO_iter list_HBCI_StO_iter;
#endif /* __cplusplus */

#include <openhbci/value.h>
#include <openhbci/date.h>
#include <openhbci/account.h>
#include <openhbci/bank.h>

#ifdef __cplusplus

namespace HBCI {

class DLLIMPORT StandingOrder : AbstractTrans {
private:
    string _jobId;
    string _ourAccountId;
    string _ourSuffix;
    string _ourBankCode;
    int _ourCountryCode;
    string _otherBankCode;
    int _otherCountryCode;
    string _otherAccountId;
    string _otherSuffix;
    list<string> _otherName;
    Value _value;
    int _transactionCode;
    list<string> _description;
    Date _execDate;

    /* details */
    Date _firstExecution;
    Date _lastExecution;
    int _period;
    int _cycle;
    int _execDay;

    /* modification flags */
    bool modOurAccount;
    bool modOtherAccount;
    bool modOtherName;
    bool modValue;
    bool modTransactionCode;
    bool modDescription;
    bool modExecDate;
    bool modDetails;

public:
    const static int EXECUTE_WEEKLY;
    const static int EXECUTE_MONTHLY;

    StandingOrder(const string &s, Pointer<Account> account);

    StandingOrder(Pointer<Account> account);

    StandingOrder();

    bool operator==(const StandingOrder &otherOrder) const;

    const string &jobIdentification() const;

    void setJobIdentification(const string &s);
    const Date &firstExecutionDate() const;

    void setFirstExecutionDate(const Date &ex);

    const Date &lastExecutionDate() const;

    void setLastExecutionDate(const Date &ex);
    const Date &executionDate() const;

    void setExecutionDate(const Date &ex);

    int cycle() const;

    void setCycle(int v=1);

    int period() const;

    void setPeriod(int c=EXECUTE_MONTHLY);

    int execDay() const;

    void setExecDay(int d=1);
    int ourCountryCode() const;
    void setOurCountryCode(int i);

    const string &ourBankCode() const;
    void setOurBankCode(const string &code);

    const string &ourAccountId() const;
    void setOurAccountId(const string &id);

    const string &ourSuffix() const;
    void setOurSuffix(const string &id);
    const Value &value() const;
    void setValue(const Value &v);
    int transactionCode() const;
    void setTransactionCode(int c);

    const list<string> &description() const;
    void addDescription(const string &s);
    int otherCountryCode() const;
    void setOtherCountryCode(int i);

    const string &otherBankCode() const;

    void setOtherBankCode(const string &s);

    const string &otherAccountId() const;
    void setOtherAccountId(const string &s);

    const string &otherSuffix() const;
    void setOtherSuffix(const string &id);

    const list<string> &otherName() const;
    void addOtherName(const string &s);
};

} /* namespace HBCI */

extern "C" {
#endif /* __cplusplus */

    extern void list_HBCI_StO_delete(list_HBCI_StO *l);
    extern int list_HBCI_StO_size(const list_HBCI_StO *l);
    extern void list_HBCI_StO_iter_delete(list_HBCI_StO_iter *l);
    extern list_HBCI_StO_iter* list_HBCI_StO_begin(const list_HBCI_StO *l);
    extern list_HBCI_StO_iter* list_HBCI_StO_end(const list_HBCI_StO *l);
    extern const HBCI_StandingOrder* 
    list_HBCI_StO_iter_get(const list_HBCI_StO_iter *l);
    extern void list_HBCI_StO_iter_next(list_HBCI_StO_iter *l);
    extern int list_HBCI_StO_iter_equal(const list_HBCI_StO_iter *l1, 
                                        const list_HBCI_StO_iter *l2);
    typedef void *(*list_HBCI_StO_cb) (const HBCI_StandingOrder *sto, 
                                       void *user_data);
    extern void *list_HBCI_StO_foreach (const list_HBCI_StO *list, 
                                        list_HBCI_StO_cb func,
                                        void *user_data);
    extern HBCI_StandingOrder * HBCI_StandingOrder_new();
    extern void HBCI_StandingOrder_delete(HBCI_StandingOrder *t);


    extern const char *
    HBCI_StandingOrder_jobIdentification(const HBCI_StandingOrder *h);

    extern void HBCI_StandingOrder_setJobIdentification(HBCI_StandingOrder *h,
                                                        const char *s);
    extern const HBCI_Date *
    HBCI_StandingOrder_firstExecutionDate(const HBCI_StandingOrder *h);

    extern void 
    HBCI_StandingOrder_setFirstExecutionDate(HBCI_StandingOrder *h, 
                                             const HBCI_Date *ex);

    extern const HBCI_Date *
    HBCI_StandingOrder_lastExecutionDate(const HBCI_StandingOrder *h);

    extern void 
    HBCI_StandingOrder_setLastExecutionDate(HBCI_StandingOrder *h,
                                            const HBCI_Date *ex);
    extern const HBCI_Date *
    HBCI_StandingOrder_executionDate(const HBCI_StandingOrder *h);

    extern void 
    HBCI_StandingOrder_setExecutionDate(HBCI_StandingOrder *h, 
                                        const HBCI_Date *ex);

    extern int HBCI_StandingOrder_cycle(const HBCI_StandingOrder *h);

    extern void HBCI_StandingOrder_setCycle(HBCI_StandingOrder *h,
                                            int v);

    extern int HBCI_StandingOrder_period(const HBCI_StandingOrder *h);

    extern void HBCI_StandingOrder_setPeriod(HBCI_StandingOrder *h,
                                             int c);

    extern int HBCI_StandingOrder_execDay(const HBCI_StandingOrder *h);

    extern void HBCI_StandingOrder_setExecDay(HBCI_StandingOrder *h, 
                                              int d);
    extern int HBCI_StandingOrder_ourCountryCode(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOurCountryCode(HBCI_StandingOrder *t, int i);

    extern const char * 
    HBCI_StandingOrder_ourBankCode(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOurBankCode(HBCI_StandingOrder *t, const char *code);

    extern const char * 
    HBCI_StandingOrder_ourAccountId(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOurAccountId(HBCI_StandingOrder *t, const char *id);

    extern const char * 
    HBCI_StandingOrder_ourSuffix(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOurSuffix(HBCI_StandingOrder *t, const char *id);
    extern const HBCI_Value* 
    HBCI_StandingOrder_value(const HBCI_StandingOrder *t);

    extern void 
    HBCI_StandingOrder_setValue(HBCI_StandingOrder *t, const HBCI_Value *v);
    extern int HBCI_StandingOrder_transactionCode(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setTransactionCode(HBCI_StandingOrder *t, int c);

    extern const list_string* 
    HBCI_StandingOrder_description(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_addDescription(HBCI_StandingOrder *t, const char *s);
    extern int 
    HBCI_StandingOrder_otherCountryCode(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOtherCountryCode(HBCI_StandingOrder *t, int i);

    extern const char * 
    HBCI_StandingOrder_otherBankCode(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOtherBankCode(HBCI_StandingOrder *t, const char *s);

    extern const char * 
    HBCI_StandingOrder_otherAccountId(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOtherAccountId(HBCI_StandingOrder *t, const char *s);

    extern const char * 
    HBCI_StandingOrder_otherSuffix(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_setOtherSuffix(HBCI_StandingOrder *t, const char *id);

    extern const list_string* 
    HBCI_StandingOrder_otherName(const HBCI_StandingOrder *t);
    extern void 
    HBCI_StandingOrder_addOtherName(HBCI_StandingOrder *t, const char *s);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif

---