statusmessagelist.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_STATUSMESSAGELIST_H
#define SWIFT_MISC_STATUSMESSAGELIST_H
 
#include <QJsonArray>
#include <QMap>
#include <QMetaType>
#include <QtGlobal>
 
#include "misc/collection.h"
#include "misc/logcategory.h"
#include "misc/logcategorylist.h"
#include "misc/orderablelist.h"
#include "misc/sequence.h"
#include "misc/statusmessage.h"
#include "misc/swiftmiscexport.h"
#include "misc/timestampobjectlist.h"
 
SWIFT_DECLARE_SEQUENCE_MIXINS(swift::misc, CStatusMessage, CStatusMessageList)
 
namespace swift::misc
{
    class SWIFT_MISC_EXPORT CStatusMessageList :
        public CSequence<CStatusMessage>,
        public ITimestampObjectList<CStatusMessage, CStatusMessageList>,
        public IOrderableList<CStatusMessage, CStatusMessageList>,
        public mixin::MetaType<CStatusMessageList>
    {
    public:
        SWIFT_MISC_DECLARE_USING_MIXIN_METATYPE(CStatusMessageList)
        using CSequence::CSequence;
 
        CStatusMessageList() = default;
 
        CStatusMessageList(const CSequence<CStatusMessage> &other);
 
        CStatusMessageList(const CStatusMessage &statusMessage);
 
        CStatusMessageList findByCategory(const CLogCategory &category) const;
 
        CStatusMessageList findBySeverity(CStatusMessage::StatusSeverity severity) const;
 
        bool hasErrorMessages() const;
 
        bool hasWarningMessages() const;
 
        bool hasWarningOrErrorMessages() const;
 
        bool isSuccess() const;
 
        bool isFailure() const;
 
        CStatusMessageList getErrorMessages() const;
 
        CStatusMessageList getWarningAndErrorMessages() const;
 
        void addCategory(const CLogCategory &category);
 
        void addValidationCategory();
 
        void addCategories(const CLogCategoryList &categories);
 
        void addValidationMessage(const QString &validationText, CStatusMessage::StatusSeverity severity);
 
        void setCategory(const CLogCategory &category);
 
        void setCategories(const CLogCategoryList &categories);
 
        void clampSeverity(CStatusMessage::StatusSeverity severity);
 
        void warningToError();
 
        void sortBySeverity();
 
        void sortBySeverityHighestFirst();
 
        void removeWarningsAndBelow();
 
        void removeSeverity(CStatusMessage::StatusSeverity severity);
 
        void removeInfoAndBelow();
 
        int keepLatest(int estimtatedNumber);
 
        CStatusMessage::StatusSeverity worstSeverity() const;
 
        QMap<int, int> countSeverities() const;
 
        CStatusMessage toSingleMessage() const;
 
        QString toHtml(const CPropertyIndexList &indexes = simpleHtmlOutput()) const;
 
        static const CPropertyIndexList &simpleHtmlOutput();
 
        static const CPropertyIndexList &timestampHtmlOutput();
 
        static const QString &htmlStyleSheet();
 
        static CStatusMessageList fromDatabaseJson(const QJsonArray &array);
    };
} // namespace swift::misc
 
Q_DECLARE_METATYPE(swift::misc::CStatusMessageList)
Q_DECLARE_METATYPE(swift::misc::CCollection<swift::misc::CStatusMessage>)
 
#endif // SWIFT_MISC_STATUSMESSAGELIST_H