validatorresult.h

/*
 * SPDX-FileCopyrightText: (C) 2017-2023 Matthias Fehring <mf@huessenbergnetz.de>
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef CUTELYSTVALIDATORRESULT_H
#define CUTELYSTVALIDATORRESULT_H

#include <Cutelyst/Plugins/Utils/validator_export.h>

#include <QJsonObject>
#include <QSharedDataPointer>
#include <QString>
#include <QStringList>
#include <QVariantHash>

namespace Cutelyst {

class ValidatorResultPrivate;

class CUTELYST_PLUGIN_UTILS_VALIDATOR_EXPORT ValidatorResult
{
public:
    ValidatorResult();

    ValidatorResult(const ValidatorResult &other) noexcept;

    ValidatorResult(ValidatorResult &&other) noexcept;

    ValidatorResult &operator=(const ValidatorResult &other) noexcept;

    ValidatorResult &operator=(ValidatorResult &&other) noexcept;

    ~ValidatorResult() noexcept;

    [[nodiscard]] bool isValid() const noexcept;

    void addError(const QString &field, const QString &message);

    [[nodiscard]] QStringList errorStrings() const;

    [[nodiscard]] QHash<QString, QStringList> errors() const noexcept;

    [[nodiscard]] QStringList errors(const QString &field) const noexcept;

    [[nodiscard]] bool hasErrors(const QString &field) const noexcept;

    [[nodiscard]] QJsonObject errorsJsonObject() const;

    [[nodiscard]] QStringList failedFields() const;

    explicit operator bool() const noexcept { return isValid(); }

    [[nodiscard]] QVariantHash values() const noexcept;

    [[nodiscard]] QVariant value(const QString &field) const noexcept;

    void addValue(const QString &field, const QVariant &value);

    [[nodiscard]] QVariantHash extras() const noexcept;

    [[nodiscard]] QVariant extra(const QString &field) const noexcept;

    void addExtra(const QString &field, const QVariant &extra);

private:
    QSharedDataPointer<ValidatorResultPrivate> d;
};

} // namespace Cutelyst

#endif // CUTELYSTVALIDATORRESULT_H