• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • TransactionSequence
Public Member Functions | Protected Slots | Protected Member Functions
Akonadi::TransactionSequence Class Reference

Base class for jobs that need to run a sequence of sub-jobs in a transaction. More...

#include <transactionsequence.h>

Inheritance diagram for Akonadi::TransactionSequence:
Inheritance graph
[legend]

List of all members.

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 Akonadi::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";
 }
Author:
Volker Krause <vkrause@kde.org>

Definition at line 69 of file transactionsequence.h.


Constructor & Destructor Documentation

TransactionSequence::TransactionSequence ( QObject *  parent = 0) [explicit]

Creates a new transaction sequence.

Parameters:
parentThe parent object.

Definition at line 75 of file transactionsequence.cpp.

TransactionSequence::~TransactionSequence ( )

Destroys the transaction sequence.

Definition at line 80 of file transactionsequence.cpp.


Member Function Documentation

bool 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:
jobThe new subjob.

Reimplemented from Akonadi::Job.

Definition at line 302 of file job.cpp.

void TransactionSequence::commit ( )

Commits the transaction as soon as all pending sub-jobs finished successfully.

Definition at line 137 of file transactionsequence.cpp.

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 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

Definition at line 192 of file transactionsequence.cpp.

void 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:
enabletrue to enable autocommitting (default), false to disable it
Since:
4.5

Definition at line 186 of file transactionsequence.cpp.

void TransactionSequence::setIgnoreJobFailure ( KJob *  job)

Sets which job of the sequence might fail without rolling back the complete transaction.

Since:
4.5

Definition at line 164 of file transactionsequence.cpp.


The documentation for this class was generated from the following files:
  • transactionsequence.h
  • job.cpp
  • specialcollectionshelperjobs.cpp
  • specialcollectionsrequestjob.cpp
  • transactionsequence.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal