Leosac::Audit::UpdateEvent Class Reference

Provides an implementation of IUpdateEvent. More...

#include <UpdateEvent.hpp>

Inheritance diagram for Leosac::Audit::UpdateEvent:

Collaboration diagram for Leosac::Audit::UpdateEvent:

Public Member Functions
std::string	generate_description () const override
	Generate a description for this event. More...
virtual	~UpdateEvent ()=default
void	target (update::IUpdatePtr u) override
	Set the update that is targeted by the event. More...
update::UpdateId	target_id () const override
	Retrieve the user_id that was targeted by this event. More...
Public Member Functions inherited from Leosac::Audit::IUpdateEvent
	MAKE_VISITABLE ()
Public Member Functions inherited from Leosac::Audit::IAuditEntry
	MAKE_VISITABLE ()
Public Member Functions inherited from Leosac::Tools::IVisitable
virtual void	accept (::Leosac::Tools::BaseVisitor &)=0
	Accept a visitor that may mutate this. More...
virtual void	accept (::Leosac::Tools::BaseVisitor &) const =0
	Accept a visitor that will not mutate this. More...
Public Member Functions inherited from Leosac::Audit::AuditEntry
	AuditEntry (const AuditEntry &)=delete
virtual	~AuditEntry ()=default
virtual AuditEntryId	id () const override
	Retrieve the identifier of the entry. More...
virtual void	finalize () override
	Mark the entry as finalized, and update it wrt the database. More...
virtual bool	finalized () const override
	Is this entry finalized. More...
virtual void	event_mask (const EventMask &mask) override
	Set the event mask for the entry. More...
virtual const EventMask &	event_mask () const override
	Retrieve the current event mask. More...
virtual void	author (Auth::UserPtr user) override
	Set the author of the entry. More...
virtual Auth::UserId	author_id () const override
	Retrieve the user id of the author of this entry. More...
virtual void	set_parent (IAuditEntryPtr parent) override
	Set parent as the parent audit entry for this entry. More...
virtual IAuditEntryPtr	parent () const override
	Retrieve the parent of this entry. More...
virtual void	remove_parent () override
	Remove the parent-child relationship between this entry and its parent. More...
virtual size_t	children_count () const override
	Returns the number of children that this entry has. More...
virtual size_t	version () const override
	Returns the ODB version of the object. More...
virtual void	reload () override
	Reload the object from the database. More...
virtual boost::posix_time::ptime	timestamp () const override
	Retrieve unix timestamp. More...
void	database (DBPtr db)
	Set the database pointer. More...

Static Public Member Functions
static std::shared_ptr< UpdateEvent >	create_empty ()
Static Public Member Functions inherited from Leosac::Audit::AuditEntry
static AuditEntryPtr	get_last_audit (DBPtr db)
	Retrieve the last (finalized) audit entry. More...

Public Attributes
update::UpdateLWPtr	target_

Private Member Functions
	UpdateEvent ()=default

Static Private Member Functions
static std::shared_ptr< UpdateEvent >	create (const DBPtr &database, update::IUpdatePtr target_update, AuditEntryPtr parent)

Friends
class	Factory
class	odb::access

Additional Inherited Members
Protected Member Functions inherited from Leosac::Audit::AuditEntry
	AuditEntry ()
Static Protected Member Functions inherited from Leosac::Tools::IVisitable
template<class T >
static bool	visitor_dispatch (T &visited, BaseVisitor &visitor, bool abort_on_failure)
Protected Attributes inherited from Leosac::Audit::AuditEntry
AuditEntryWPtr	parent_
std::string	msg_
Auth::UserLPtr	author_
	The user at the source of the entry. More...
EventMask	event_mask_
size_t	duration_
	How long did it take for the Audit object to be finalized. More...
bool	finalized_
	Audit entry are sometime persisted multiple time before reaching their final state. More...
DBPtr	database_
	Pointer to the database. More...
Tools::ElapsedTimeCounter	etc_
	Keep track of how long the object has been alive. More...

Detailed Description

Provides an implementation of IUpdateEvent.

Definition at line 33 of file UpdateEvent.hpp.

Constructor & Destructor Documentation

UpdateEvent()

Leosac::Audit::UpdateEvent::UpdateEvent ( )

privatedefault

~UpdateEvent()

virtual Leosac::Audit::UpdateEvent::~UpdateEvent ( )

virtualdefault

Member Function Documentation

create()

std::shared_ptr< UpdateEvent > Leosac::Audit::UpdateEvent::create ( const DBPtr &  database, update::IUpdatePtr  target_update, AuditEntryPtr  parent  )

staticprivate

Definition at line 31 of file UpdateEvent.cpp.

create_empty()

std::shared_ptr< UpdateEvent > Leosac::Audit::UpdateEvent::create_empty ( )

static

Definition at line 68 of file UpdateEvent.cpp.

generate_description()

std::string Leosac::Audit::UpdateEvent::generate_description ( ) const

overridevirtual

Generate a description for this event.

todo: should be pure virtual

Reimplemented from Leosac::Audit::IAuditEntry.

Definition at line 73 of file UpdateEvent.cpp.

target()

void Leosac::Audit::UpdateEvent::target ( update::IUpdatePtr  u )

overridevirtual

Set the update that is targeted by the event.

Implements Leosac::Audit::IUpdateEvent.

Definition at line 55 of file UpdateEvent.cpp.

target_id()

update::UpdateId Leosac::Audit::UpdateEvent::target_id ( ) const

overridevirtual

Retrieve the user_id that was targeted by this event.

Implements Leosac::Audit::IUpdateEvent.

Definition at line 61 of file UpdateEvent.cpp.

Friends And Related Function Documentation

Factory

friend class Factory

friend

Definition at line 38 of file UpdateEvent.hpp.

odb::access

friend class odb::access

friend

Definition at line 59 of file UpdateEvent.hpp.

Member Data Documentation

target_

update::UpdateLWPtr Leosac::Audit::UpdateEvent::target_

Definition at line 57 of file UpdateEvent.hpp.

---

The documentation for this class was generated from the following files:

• src/core/audit/UpdateEvent.hpp
• src/core/audit/UpdateEvent.cpp