IPatch.h

/*
 * Copyright 2021-2022 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/utility/Linkage.h>

#include <QFuture>

namespace quentier::local_storage {

class QUENTIER_EXPORT IPatch
{
public:
    virtual ~IPatch() noexcept;

    [[nodiscard]] virtual int fromVersion() const noexcept = 0;

    [[nodiscard]] virtual int toVersion() const noexcept = 0;

    [[nodiscard]] virtual QString patchShortDescription() const = 0;

    [[nodiscard]] virtual QString patchLongDescription() const = 0;

    [[nodiscard]] virtual QFuture<void> backupLocalStorage() = 0;

    [[nodiscard]] virtual QFuture<void> restoreLocalStorageFromBackup() = 0;

    [[nodiscard]] virtual QFuture<void> removeLocalStorageBackup() = 0;

    [[nodiscard]] virtual QFuture<void> apply() = 0;
};

} // namespace quentier::local_storage