storageTransactionInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_STORAGE_TRANSACTION_INTERFACE_HPP_INCLUDED
#define _STRUS_STORAGE_TRANSACTION_INTERFACE_HPP_INCLUDED
#include <string>
#include "strus/storageDocumentInterface.hpp"
#include "strus/numericVariant.hpp"

namespace strus
{

class StorageDocumentInterface;
class StorageDocumentUpdateInterface;

class StorageTransactionInterface
{
public:
        virtual ~StorageTransactionInterface(){}

        virtual StorageDocumentInterface*
                createDocument( const std::string& docid_)=0;

        virtual StorageDocumentUpdateInterface*
                createDocumentUpdate(
                        const Index& docno_)=0;

        virtual void deleteDocument(
                        const std::string& docid)=0;

        virtual void deleteUserAccessRights(
                        const std::string& username)=0;

        virtual void updateMetaData(
                        const Index& docno,
                        const std::string& varname,
                        const NumericVariant& value)=0;

        virtual void updateDocumentFrequency( const std::string& type, const std::string& value, int df_change)=0;

        virtual bool commit()=0;

        virtual void rollback()=0;

        virtual unsigned int nofDocumentsAffected() const=0;
};

}//namespace
#endif