qgstransaction.h

Go to the documentation of this file.

/***************************************************************************
                              qgstransaction.h
                              ----------------
  begin                : May 5, 2014
  copyright            : (C) 2014 by Marco Hugentobler
  email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSTRANSACTION_H
#define QGSTRANSACTION_H

#include <QSet>
#include <QString>

class QgsVectorDataProvider;

class CORE_EXPORT QgsTransaction
{
  public:
    static QgsTransaction* create( const QString& connString, const QString& providerKey );

    static QgsTransaction* create( const QStringList& layerIds );

    virtual ~QgsTransaction();

    bool addLayer( const QString& layerId );

    bool begin( QString& errorMsg, int statementTimeout = 20 );

    bool commit( QString& errorMsg );

    bool rollback( QString& errorMsg );

    virtual bool executeSql( const QString& sql, QString& error ) = 0;

  protected:
    QgsTransaction( const QString& connString );

    QString mConnString;

  private:
    QgsTransaction( const QgsTransaction& other );
    const QgsTransaction& operator=( const QgsTransaction& other );

    bool mTransactionActive;
    QSet<QString> mLayers;

    void setLayerTransactionIds( QgsTransaction *transaction );

    virtual bool beginTransaction( QString& error, int statementTimeout ) = 0;
    virtual bool commitTransaction( QString& error ) = 0;
    virtual bool rollbackTransaction( QString& error ) = 0;
};

#endif // QGSTRANSACTION_H