Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

HBCI::OutboxJobDisableKeys Class Reference

Job that locks both, the current crypt and sign key of a user. More...

#include <outboxjobkeys.h>

Inheritance diagram for HBCI::OutboxJobDisableKeys:

Inheritance graph
[legend]
List of all members.

Public Methods

 OutboxJobDisableKeys (const API *api, Pointer< Customer > c)
 ~OutboxJobDisableKeys ()
virtual bool createHBCIJobs (Pointer< MessageQueue > mbox, int n=0)
bool commit (int msgNumber=HBCI_COMMIT_WHOLE_JOB)
string description () const
int messages () const
JobProgressType type () const

Protected Attributes

Pointer< Job > _job

Detailed Description

Job that locks both, the current crypt and sign key of a user.

This job locks the cryptographic keys and tells the bankserver not to accept them anymore.

Author:
Fabian Kaiser<fabian@openhbci.de>


Constructor & Destructor Documentation

HBCI::OutboxJobDisableKeys::OutboxJobDisableKeys const API   api,
Pointer< Customer   c
 

HBCI::OutboxJobDisableKeys::~OutboxJobDisableKeys  
 


Member Function Documentation

bool HBCI::OutboxJobDisableKeys::commit int    msgNumber = HBCI_COMMIT_WHOLE_JOB [virtual]
 

Call this method to commit changes to the system.

Since Jobs do not change the system you may call this method to commit the changes. A job for getting the balance for example may decide to store the retrieved balance in the corresponding account.

Parameters:
msgNumber  Number of the message for which the response should be committed. As a job may consist of more than one message, it might be necessary to commit recieved changes before the rest of the job is sent. This method is called for each message and finally for the whole job (if called for the whol job, msgNumber is set to HBCI_COMMIT_WHOLE_JOB)
Author:
Martin Preuss<martin@libchipcard.de>
Returns :
true on success, false otherwise

Reimplemented from HBCI::OutboxJobKeys.

virtual bool HBCI::OutboxJobDisableKeys::createHBCIJobs Pointer< MessageQueue >    mbox,
int    n = 0
[virtual]
 

Let the job create the "real" jobs and add them to the message queue given.

Author:
Martin Preuss<martin@libchipcard.de>
Returns :
true on success, false otherwise
Parameters:
mbox  pointer to the messagebox to add the jobs to
n  the number of the message to create. In most cases this is zero.

Reimplemented from HBCI::OutboxJobKeys.

Reimplemented in HBCI::OutboxJobDisableLostKeys.

string HBCI::OutboxJobDisableKeys::description   const [inline, virtual]
 

Return a short description of what the job is supposed to do.

Author:
Martin Preuss<martin@libchipcard.de>

Reimplemented from HBCI::OutboxJobKeys.

int HBCI::OutboxJobDisableKeys::messages   const [inline, virtual]
 

Returns the number of messages this job needs.

This method is used to calculate the return value of OutboxJob::stillMessagesToSend, and it is used by API::_handleJobQueue to determine the number of actions that are going to be started.

If this is a dialog job, then it consists of at least two messages:

  • dialog init message
  • dialog closing message
Since not all jobs may be mixed in ONE message this method returns the number of messages it needs.

Author:
Martin Preuss<martin@libchipcard.de>

Reimplemented from HBCI::OutboxJobKeys.

Reimplemented in HBCI::OutboxJobDisableLostKeys.

JobProgressType HBCI::OutboxJobDisableKeys::type   const [inline, virtual]
 

Return the JobProgressType of this job.

Author:
Christian Stimming <stimming@tuhh.de>

Implements HBCI::OutboxJob.


Member Data Documentation

Pointer<Job> HBCI::OutboxJobDisableKeys::_job [protected]
 


The documentation for this class was generated from the following file:
Generated on Mon Jun 23 13:41:13 2003 for openhbci by doxygen1.2.17