Leosac  0.8.0
Open Source Access Control
Leosac::Audit::IUserGroupMembershipEvent Class Referenceabstract

Interface to audit object that take care of tracking user/group membership change. More...

#include <IUserGroupMembershipEvent.hpp>

+ Inheritance diagram for Leosac::Audit::IUserGroupMembershipEvent:
+ Collaboration diagram for Leosac::Audit::IUserGroupMembershipEvent:

Public Member Functions

 MAKE_VISITABLE ()
 
virtual void target_user (Auth::UserPtr user)=0
 The user that joined or left the group. More...
 
virtual Auth::UserId target_user_id () const =0
 
virtual void target_group (Auth::GroupPtr grp)=0
 The group that gained or lost an user. More...
 
virtual Auth::GroupId target_group_id () 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 EventMaskevent_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 to audit object that take care of tracking user/group membership change.

Definition at line 33 of file IUserGroupMembershipEvent.hpp.

Member Function Documentation

◆ MAKE_VISITABLE()

Leosac::Audit::IUserGroupMembershipEvent::MAKE_VISITABLE ( )

◆ target_group()

virtual void Leosac::Audit::IUserGroupMembershipEvent::target_group ( Auth::GroupPtr  grp)
pure virtual

The group that gained or lost an user.

Implemented in Leosac::Audit::UserGroupMembershipEvent.

◆ target_group_id()

virtual Auth::GroupId Leosac::Audit::IUserGroupMembershipEvent::target_group_id ( ) const
pure virtual

◆ target_user()

virtual void Leosac::Audit::IUserGroupMembershipEvent::target_user ( Auth::UserPtr  user)
pure virtual

The user that joined or left the group.

Implemented in Leosac::Audit::UserGroupMembershipEvent.

◆ target_user_id()

virtual Auth::UserId Leosac::Audit::IUserGroupMembershipEvent::target_user_id ( ) const
pure virtual

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