---

outboxjob.h

Go to the documentation of this file.

/* outboxjob.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 OUTBOXJOB_H
#define OUTBOXJOB_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/statusreport.h>
#include <openhbci/listwrappers.h>
#include <openhbci/progressmonitor.h>


typedef enum OutboxJob_Status {
    HBCI_JOB_STATUS_NONE = 0,
    HBCI_JOB_STATUS_TODO,
    HBCI_JOB_STATUS_DONE
} OutboxJob_Status;
typedef enum OutboxJob_Result {
    HBCI_JOB_RESULT_NONE = 0,
    HBCI_JOB_RESULT_SUCCESS,
    HBCI_JOB_RESULT_FAILED
} OutboxJob_Result;

#ifdef __cplusplus
#include <openhbci/messagequeue.h>
/* Forward declaration */
namespace HBCI {
  class OutboxJob;
};
typedef HBCI::OutboxJob HBCI_OutboxJob;
#include <openhbci/api.h>

/* Used to tell the the commit()-method that not the response for a
 * single message should be committed, but the response for the whole
 * job.  This is because a job may consist of more than one message,
 * and it might be necessary to commit recieved changes before the
 * rest of the job is sent. */
#define HBCI_COMMIT_WHOLE_JOB  -1

namespace HBCI {

class DLLIMPORT OutboxJob {
    friend class API;
    friend class Outbox;
    friend class customerQueue;
  private:
    OutboxJob_Status _status;
    int _id;
    list<Pointer<Customer> > _signers;
    MessageReference _msgReference;
  protected:
    Pointer<Customer> _cust;
    Pointer<Bank> _bank;
    OutboxJob_Result _result;

  public:
    OutboxJob(Pointer<Customer> c);
    virtual ~OutboxJob();

    Pointer<Customer> customer() const { return _cust;};

    void addSigner(Pointer<Customer> c);
    OutboxJob_Status status() const { return _status;};

    OutboxJob_Result result() const { return _result;};

    int id() const { return _id;};

    virtual string description() const = 0;

    virtual list<int> resultCodes() const = 0;

    const MessageReference &messageReference() const { return _msgReference;};

    virtual int segmentForStatusReport() const;

    virtual JobProgressType type() const = 0;
    
  protected:

    void addSignersToQueue(Pointer<MessageQueue> q) const;

    virtual int messages() const { return 1;};

    static list<int> resultCodesFromJob(const Job& job);

    void setId(int i) { _id=i;};

    void setMessageReference(const MessageReference &ref);

    void setStatus(OutboxJob_Status s) { _status=s;};

    virtual bool createHBCIJobs(Pointer<MessageQueue> mbox, int n=0)=0;

    virtual bool evaluate()=0;

    virtual bool commit(int msgNumber=HBCI_COMMIT_WHOLE_JOB)=0;
    virtual bool isDialogJob() const { return false;};

    virtual bool stillMessagesToSend(int nextMsg) const
        { return nextMsg < messages(); };
};

} /* namespace HBCI */

extern "C" {
#else /* __cplusplus */
    typedef struct HBCI_OutboxJob HBCI_OutboxJob;
#endif /* __cplusplus */

    extern void HBCI_OutboxJob_delete(HBCI_OutboxJob *j);

    extern void HBCI_OutboxJob_addSigner(HBCI_OutboxJob *j, 
                                         const HBCI_Customer *c);
    extern OutboxJob_Status HBCI_OutboxJob_status(const HBCI_OutboxJob *j);

    extern OutboxJob_Result HBCI_OutboxJob_result(const HBCI_OutboxJob *j);

    extern int HBCI_OutboxJob_id(const HBCI_OutboxJob *j);

    extern list_int *HBCI_OutboxJob_resultCodes(const HBCI_OutboxJob *j);

    extern const HBCI_MessageReference *
    HBCI_OutboxJob_messageReference(const HBCI_OutboxJob *j);

    extern int HBCI_OutboxJob_segmentForStatusReport(const HBCI_OutboxJob *j);

    extern JobProgressType HBCI_OutboxJob_type(const HBCI_OutboxJob *j);
    

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif

---