akonadi
Akonadi::TransactionSequence Class Reference
Base class for jobs that need to run a sequence of sub-jobs in a transaction. More...
#include <transactionsequence.h>

Public Member Functions | |
TransactionSequence (QObject *parent=0) | |
~TransactionSequence () | |
void | commit () |
void | rollback () |
void | setAutomaticCommittingEnabled (bool enable) |
void | setIgnoreJobFailure (KJob *job) |
Protected Slots | |
void | slotResult (KJob *job) |
Protected Member Functions | |
bool | addSubjob (KJob *job) |
void | doStart () |
Detailed Description
Base class for jobs that need to run a sequence of sub-jobs in a transaction.
As soon as the first subjob is added, the transaction is started. As soon as the last subjob has successfully finished, the transaction is committed. If any subjob fails, the transaction is rolled back.
Alternatively, a TransactionSequence object can be used as a parent object for a set of jobs to achieve the same behaviour without subclassing.
Example:
// Delete a couple of items inside a transaction Akonadi::TransactionSequence *transaction = new TransactionSequence; connect( transaction, SIGNAL( result( KJob* ) ), SLOT( transactionFinished( KJob* ) ) ); const Akonadi::Item::List items = ... foreach ( const Akonadi::Item &item, items ) { new Akonadi::ItemDeleteJob( item, transaction ); } ... MyClass::transactionFinished( KJob *job ) { if ( job->error() ) qDebug() << "Error occurred"; else qDebug() << "Items deleted successfully"; }
Definition at line 69 of file transactionsequence.h.
Constructor & Destructor Documentation
Akonadi::TransactionSequence::TransactionSequence | ( | QObject * | parent = 0 |
) | [explicit] |
Creates a new transaction sequence.
- Parameters:
-
parent The parent object.
Akonadi::TransactionSequence::~TransactionSequence | ( | ) |
Destroys the transaction sequence.
Member Function Documentation
bool Akonadi::TransactionSequence::addSubjob | ( | KJob * | job | ) | [protected, virtual] |
Adds the given job as a subjob to this job.
This method is automatically called if you construct a job using another job as parent object. The base implementation does the necessary setup to share the network connection with the backend.
- Parameters:
-
job The new subjob.
Reimplemented from Akonadi::Job.
void Akonadi::TransactionSequence::commit | ( | ) |
Commits the transaction as soon as all pending sub-jobs finished successfully.
void Akonadi::TransactionSequence::doStart | ( | ) | [protected, virtual] |
This method must be reimplemented in the concrete jobs.
It will be called after the job has been started and a connection to the Akonadi backend has been established.
Implements Akonadi::Job.
Reimplemented in Akonadi::CollectionSync, and Akonadi::SpecialCollectionsRequestJob.
void Akonadi::TransactionSequence::rollback | ( | ) |
Rolls back the current transaction as soon as possible.
You only need to call this method when you want to roll back due to external reasons (e.g. user cancellation), the transaction is automatically rolled back if one of its subjobs fails.
- Since:
- 4.5
void Akonadi::TransactionSequence::setAutomaticCommittingEnabled | ( | bool | enable | ) |
Disable automatic committing.
Use this when you want to add jobs to this sequence after execution has been started, usually that is outside of the contstructor or the method that creates this transaction sequence.
- Note:
- Calling this method after execution of this job has been started has no effect.
- Parameters:
-
enable true
to enable autocommitting (default),false
to disable it
- Since:
- 4.5
void Akonadi::TransactionSequence::setIgnoreJobFailure | ( | KJob * | job | ) |
Sets which job of the sequence might fail without rolling back the complete transaction.
- Since:
- 4.5
The documentation for this class was generated from the following file: