---

outboxstojobs.h

Go to the documentation of this file.

/* outboxstojobs.h

 ***************************************************************************
 *                                                                         *
 *   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 OUTBOXSTOJOBS_H
#define OUTBOXSTOJOBS_H

#ifdef __cplusplus
#include <string>
#include <list>
#endif /* __cplusplus */

#include <openhbci/dllimport.h>
#include <openhbci/pointer.h>
#include <openhbci/customer.h>
#include <openhbci/user.h>
#include <openhbci/bank.h>
#include <openhbci/account.h>
#include <openhbci/outboxaccjobs.h>
#include <openhbci/limit.h>

#ifdef __cplusplus

namespace HBCI {

class DLLIMPORT OutboxJobGetStandingOrders: public OutboxAccountJob {
private:
    Pointer<Job> _job;
    list<Pointer<StandingOrder> > _orders;
public:
    OutboxJobGetStandingOrders(Pointer<Customer> c,
                               Pointer<Account> a);
    ~OutboxJobGetStandingOrders();

    const list<Pointer<StandingOrder> > &getOrders() const;

        static bool isSupported(Pointer<Account> forAccount);

    bool createHBCIJobs(Pointer<MessageQueue> mbox, int n=0);
    bool evaluate();
    bool stillMessagesToSend(int nextMsg) const;
    bool commit(int msgNumber=HBCI_COMMIT_WHOLE_JOB);
    string description() const;
    JobProgressType type() const { return JOB_GET_STO; };
    list<int> resultCodes() const;
};

} /* namespace HBCI */
typedef struct HBCI::OutboxJobGetStandingOrders HBCI_OutboxJobGetStOs;
extern "C" {
#else /* __cplusplus */
    typedef struct HBCI_OutboxJobGetStOs HBCI_OutboxJobGetStOs;
#endif /* __cplusplus */

    extern HBCI_OutboxJobGetStOs *
    HBCI_OutboxJobGetStOs_new(const HBCI_Customer *c, 
                              HBCI_Account *a);
    extern HBCI_OutboxJob *
    HBCI_OutboxJobGetStOs_OutboxJob(HBCI_OutboxJobGetStOs *j);
    extern const list_HBCI_StO *
    HBCI_OutboxJobGetStOs_getOrders(const HBCI_OutboxJobGetStOs *j);
#ifdef __cplusplus
}

namespace HBCI {
class DLLIMPORT OutboxJobNewStandingOrder: public OutboxAccountJob {
private:
    Pointer<Job> _job;
    StandingOrder _newOrder;
public:
    OutboxJobNewStandingOrder(Pointer<Customer> c,
                              Pointer<Account> a,
                              const StandingOrder &newOrder);
    ~OutboxJobNewStandingOrder();

    /* retrieve date that is needed to create a valid order for this account */

    static int maxDescriptionLines(const Bank &forBank);

    static int minDaysToExec(const Bank &forBank);

    static int maxDaysToExec(const Bank &forBank);

    static list<int> monthlyCycle(const Bank &forBank);

    static list<int> execDaysMonth(const Bank &forBank);

    static list<int> weeklyCycle(const Bank &forBank);

    static list<int> execDaysWeek(const Bank &forBank);

    static list<int> transactionCodes(const Bank &forBank);

        static bool isSupported(Pointer<Account> forAccount);

        static const Limit limit(Pointer<Account> forAccount);

    const StandingOrder &standingOrder() const { return _newOrder;};

    bool createHBCIJobs(Pointer<MessageQueue> mbox, int n=0);
    bool evaluate();
    bool stillMessagesToSend(int nextMsg) const;
    bool commit(int msgNumber=HBCI_COMMIT_WHOLE_JOB);
    string description() const;
    JobProgressType type() const { return JOB_NEW_STO; };
    list<int> resultCodes() const;
};

} /* namespace HBCI */
typedef struct HBCI::OutboxJobNewStandingOrder HBCI_OutboxJobNewStO;
extern "C" {
#else /* __cplusplus */
    typedef struct HBCI_OutboxJobNewStO HBCI_OutboxJobNewStO;
#endif /* __cplusplus */

    extern HBCI_OutboxJobNewStO *
    HBCI_OutboxJobNewStO_new(const HBCI_Customer *c, 
                             HBCI_Account *a,
                             const HBCI_StandingOrder *sto);
    extern HBCI_OutboxJob *
    HBCI_OutboxJobNewStO_OutboxJob(HBCI_OutboxJobNewStO *j);
#ifdef __cplusplus
}

namespace HBCI {
class DLLIMPORT OutboxJobDeleteStandingOrder: public OutboxAccountJob {
private:
    Pointer<Job> _job;
    StandingOrder _order2Delete;
public:
    OutboxJobDeleteStandingOrder(Pointer<Customer> c,
                              Pointer<Account> a,
                              const StandingOrder &order2Delete);
    ~OutboxJobDeleteStandingOrder();

    static int minDaysBeforeDelete(const Bank &forBank);

    static int maxDaysBeforeDelete(const Bank &forBank);

    static bool deletionTerminable(const Bank &forBank);

        static bool isSupported(Pointer<Account> forAccount);

    const StandingOrder &standingOrder() const { return _order2Delete;};

    bool createHBCIJobs(Pointer<MessageQueue> mbox, int n=0);
    bool evaluate();
    bool stillMessagesToSend(int nextMsg) const;
    bool commit(int msgNumber=HBCI_COMMIT_WHOLE_JOB);
    string description() const;
    JobProgressType type() const { return JOB_DELETE_STO; };
    list<int> resultCodes() const;
};

} /* namespace HBCI */
typedef struct HBCI::OutboxJobDeleteStandingOrder HBCI_OutboxJobDeleteStO;
extern "C" {
#else /* __cplusplus */
    typedef struct HBCI_OutboxJobDeleteStO HBCI_OutboxJobDeleteStO;
#endif /* __cplusplus */

    extern HBCI_OutboxJobDeleteStO *
    HBCI_OutboxJobDeleteStO_new(const HBCI_Customer *c, 
                                HBCI_Account *a,
                                const HBCI_StandingOrder *sto);
    extern HBCI_OutboxJob *
    HBCI_OutboxJobDeleteStO_OutboxJob(HBCI_OutboxJobDeleteStO *j);
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif

---