IAuditEntry.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2014-2016 Leosac

    This file is part of Leosac.

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

    Leosac 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once

#include "core/audit/AuditFwd.hpp"
#include "core/auth/AuthFwd.hpp"
#include "tools/IVisitable.hpp"
#include <boost/date_time/posix_time/posix_time.hpp>
#include <memory>

namespace Leosac
{
namespace Audit
{
class IAuditEntry : public virtual Tools::IVisitable
{
  public:
    MAKE_VISITABLE();

    virtual AuditEntryId id() const = 0;

    virtual void finalize() = 0;

    virtual bool finalized() const = 0;

    virtual void reload() = 0;

    virtual void event_mask(const EventMask &mask) = 0;

    virtual const EventMask &event_mask() const = 0;

    virtual void author(Auth::UserPtr user) = 0;

    virtual Auth::UserId author_id() const = 0;

    virtual void set_parent(IAuditEntryPtr parent) = 0;

    virtual IAuditEntryPtr parent() const = 0;

    virtual void remove_parent() = 0;

    virtual size_t children_count() const = 0;

    virtual boost::posix_time::ptime timestamp() const = 0;

    virtual std::string generate_description() const
    {
        return "";
    }

    virtual size_t version() const = 0;
};
}
}