Leosac::Audit::IUserEvent Class Reference

Interface that describes an Audit object when a user-related event happens. More...

#include <IUserEvent.hpp>

Inheritance diagram for Leosac::Audit::IUserEvent:

Collaboration diagram for Leosac::Audit::IUserEvent:

Public Member Functions
	MAKE_VISITABLE ()
virtual void	target (Auth::UserPtr user)=0
	Set the user that is targeted by the event. More...
virtual Auth::UserLPtr	target () const =0
virtual Auth::UserId	target_id () const =0
	Retrieve the user_id that was targeted by this event. More...
virtual void	before (const std::string &repr)=0
	An optional JSON representation of the object before the event took place. More...
virtual const std::string &	before () const =0
virtual void	after (const std::string &repr)=0
	An optional JSON representation of the object after the event took place. More...
virtual const std::string &	after () const =0
Public Member Functions inherited from Leosac::Audit::IAuditEntry
	MAKE_VISITABLE ()
virtual AuditEntryId	id () const =0
	Retrieve the identifier of the entry. More...
virtual void	finalize ()=0
	Mark the entry as finalized, and update it wrt the database. More...
virtual bool	finalized () const =0
	Is this entry finalized. More...
virtual void	reload ()=0
	Reload the object from the database. More...
virtual void	event_mask (const EventMask &mask)=0
	Set the event mask for the entry. More...
virtual const EventMask &	event_mask () const =0
	Retrieve the current event mask. More...
virtual void	author (Auth::UserPtr user)=0
	Set the author of the entry. More...
virtual Auth::UserId	author_id () const =0
	Retrieve the user id of the author of this entry. More...
virtual void	set_parent (IAuditEntryPtr parent)=0
	Set parent as the parent audit entry for this entry. More...
virtual IAuditEntryPtr	parent () const =0
	Retrieve the parent of this entry. More...
virtual void	remove_parent ()=0
	Remove the parent-child relationship between this entry and its parent. More...
virtual size_t	children_count () const =0
	Returns the number of children that this entry has. More...
virtual boost::posix_time::ptime	timestamp () const =0
	Retrieve unix timestamp. More...
virtual std::string	generate_description () const
	Generate a description for this event. More...
virtual size_t	version () const =0
	Returns the ODB version of the object. More...
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...

Additional Inherited Members
Static Protected Member Functions inherited from Leosac::Tools::IVisitable
template<class T >
static bool	visitor_dispatch (T &visited, BaseVisitor &visitor, bool abort_on_failure)

Detailed Description

Interface that describes an Audit object when a user-related event happens.

Possible use case:

• User profile edition.
• User creation/deletion.

Definition at line 37 of file IUserEvent.hpp.

Member Function Documentation

after() [1/2]

virtual const std::string& Leosac::Audit::IUserEvent::after ( ) const

pure virtual

Implemented in Leosac::Audit::UserEvent.

after() [2/2]

virtual void Leosac::Audit::IUserEvent::after ( const std::string &  repr )

pure virtual

An optional JSON representation of the object after the event took place.

Implemented in Leosac::Audit::UserEvent.

before() [1/2]

virtual const std::string& Leosac::Audit::IUserEvent::before ( ) const

pure virtual

Implemented in Leosac::Audit::UserEvent.

before() [2/2]

virtual void Leosac::Audit::IUserEvent::before ( const std::string &  repr )

pure virtual

An optional JSON representation of the object before the event took place.

Implemented in Leosac::Audit::UserEvent.

MAKE_VISITABLE()

Leosac::Audit::IUserEvent::MAKE_VISITABLE

(

)

target() [1/2]

virtual Auth::UserLPtr Leosac::Audit::IUserEvent::target ( ) const

pure virtual

Implemented in Leosac::Audit::UserEvent.

target() [2/2]

virtual void Leosac::Audit::IUserEvent::target ( Auth::UserPtr  user )

pure virtual

Set the user that is targeted by the event.

Implemented in Leosac::Audit::UserEvent.

target_id()

virtual Auth::UserId Leosac::Audit::IUserEvent::target_id ( ) const

pure virtual

Retrieve the user_id that was targeted by this event.

Implemented in Leosac::Audit::UserEvent.

---

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

• src/core/audit/IUserEvent.hpp