File indexing completed on 2024-11-10 04:40:32

 /*
     SPDX-FileCopyrightText: 2006 Volker Krause <vkrause@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "akonadicore_export.h"
 #include "job.h"
 
 namespace Akonadi
 {
 class TransactionJobPrivate;
 class AKONADICORE_EXPORT TransactionJob : public Job
 {
     Q_OBJECT
 
 public:
     ~TransactionJob() override;
 
 protected:
     explicit TransactionJob(QObject *parent);
 
     void doStart() override;
     bool doHandleResponse(qint64 tag, const Protocol::CommandPtr &response) override;
 
 private:
     Q_DECLARE_PRIVATE(TransactionJob)
 };
 
 class TransactionJobPrivate;
 
 /**
  * @short Job that begins a session-global transaction.
  *
  * Sometimes you want to execute a sequence of commands in
  * an atomic way, so that either all commands or none shall
  * be executed. The TransactionBeginJob, TransactionCommitJob and
  * TransactionRollbackJob provide these functionality for the
  * Akonadi Job classes.
  *
  * @note This will only have an effect when used as a subjob or with a Session.
  *
  * @author Volker Krause <vkrause@kde.org>
  */
 class AKONADICORE_EXPORT TransactionBeginJob : public TransactionJob
 {
     Q_OBJECT
 
 public:
     /**
      * Creates a new transaction begin job.
      *
      * @param parent The parent job or Session, must not be 0.
      */
     explicit TransactionBeginJob(QObject *parent);
 
     /**
      * Destroys the transaction begin job.
      */
     ~TransactionBeginJob() override;
 };
 
 /**
  * @short Job that aborts a session-global transaction.
  *
  * If a job inside a TransactionBeginJob has been failed,
  * the TransactionRollbackJob can be used to rollback all changes done by these
  * jobs.
  *
  * @note This will only have an effect when used as a subjob or with a Session.
  *
  * @author Volker Krause <vkrause@kde.org>
  */
 class AKONADICORE_EXPORT TransactionRollbackJob : public TransactionJob
 {
     Q_OBJECT
 
 public:
     /**
      * Creates a new transaction rollback job.
      * The parent must be the same parent as for the TransactionBeginJob.
      *
      * @param parent The parent job or Session, must not be 0.
      */
     explicit TransactionRollbackJob(QObject *parent);
 
     /**
      * Destroys the transaction rollback job.
      */
     ~TransactionRollbackJob() override;
 };
 
 /**
  * @short Job that commits a session-global transaction.
  *
  * This job commits all changes of this transaction.
  *
  * @author Volker Krause <vkrause@kde.org>
  */
 class AKONADICORE_EXPORT TransactionCommitJob : public TransactionJob
 {
     Q_OBJECT
 
 public:
     /**
      * Creates a new transaction commit job.
      * The parent must be the same parent as for the TransactionBeginJob.
      *
      * @param parent The parent job or Session, must not be 0.
      */
     explicit TransactionCommitJob(QObject *parent);
 
     /**
      * Destroys the transaction commit job.
      */
     ~TransactionCommitJob() override;
 };
 
 }