Provide management of users. More...

#include <IUsersManager.h>

Inheritance diagram for iauth::IUsersManager:

Collaboration diagram for iauth::IUsersManager:

Public Types
enum	ChangeFlags { CF_USER_ADDED = 0x36e7c73 , CF_USER_REMOVED , CF_USER_RENAMED }
	Data model change notification flags. More...

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
virtual int	GetUsersCount () const =0
	Get number of users in this collection.

virtual int	FindUserIndex (const QString &name) const =0
	Search for user with specified name.

virtual const CUser &	GetUser (int index) const =0
	Get user using its index.

virtual CUser &	GetUserRef (int index)=0
	Get reference to user object using its index.

virtual CUser *	AddUser (const QString &userName)=0
	Add a new user to the user list.

virtual bool	DeleteUser (const QString &userName)=0
	Delete the user with the user name.

virtual bool	RenameUser (int userIndex, const QString &userName)=0
	The method renames the user.

virtual int	GetUserGroupsCount () const =0
	Get number of user groups.

virtual const QString &	GetUserGroupName (int groupIndex) const =0
	Get number of user groups.

Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.

virtual quint32	GetMinimalVersion (int versionId) const
	Get minimal needed version to correct storing of this data.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Provide management of users.

Definition at line 24 of file IUsersManager.h.

Member Enumeration Documentation

◆ ChangeFlags

enum iauth::IUsersManager::ChangeFlags

Data model change notification flags.

Enumerator
CF_USER_ADDED
CF_USER_REMOVED
CF_USER_RENAMED

Definition at line 30 of file IUsersManager.h.

Member Function Documentation

◆ AddUser()

virtual CUser * iauth::IUsersManager::AddUser ( const QString & userName )

pure virtual

Add a new user to the user list.

Parameters

QString Username: The user name of the new user. There can be each user name only once.

Returns: pointer to user object, if user was added correctly, otherwise nullptr.

Implemented in iauth::CUsersManagerComp.

◆ DeleteUser()

virtual bool iauth::IUsersManager::DeleteUser ( const QString & userName )

pure virtual

Delete the user with the user name.

Parameters

QString Username: The user name of the user which shall be deleted.

Returns: true if the user was successfully deleted, otherwise false

Implemented in iauth::CUsersManagerComp.

◆ FindUserIndex()

virtual int iauth::IUsersManager::FindUserIndex ( const QString & name ) const

pure virtual

Search for user with specified name.

Returns: index of user, or negative value, if no user found.

Implemented in iauth::CUsersManagerComp.

◆ GetUser()

virtual const CUser & iauth::IUsersManager::GetUser ( int index ) const

pure virtual

Get user using its index.

Implemented in iauth::CUsersManagerComp.

◆ GetUserGroupName()

virtual const QString & iauth::IUsersManager::GetUserGroupName ( int groupIndex ) const

pure virtual

Get number of user groups.

Implemented in iauth::CUsersManagerComp.

◆ GetUserGroupsCount()

virtual int iauth::IUsersManager::GetUserGroupsCount ( ) const

pure virtual

Get number of user groups.

Implemented in iauth::CUsersManagerComp.

◆ GetUserRef()

virtual CUser & iauth::IUsersManager::GetUserRef ( int index )

pure virtual

Get reference to user object using its index.

Implemented in iauth::CUsersManagerComp.

◆ GetUsersCount()

virtual int iauth::IUsersManager::GetUsersCount ( ) const

pure virtual

Get number of users in this collection.

Implemented in iauth::CUsersManagerComp.

◆ RenameUser()

virtual bool iauth::IUsersManager::RenameUser	(	int	userIndex,
		const QString &	userName )

pure virtual

The method renames the user.

You should not call method CUser::SetUserName() directly, because of user name is used as primary key of user list.

Parameters

QString	userIndex: user index.
QString	userName: the new user name.

Returns: true if the user name could be changed, otherwise false.

Implemented in iauth::CUsersManagerComp.

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

iauth/IUsersManager.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ChangeFlags

Member Function Documentation

◆ AddUser()

◆ DeleteUser()

◆ FindUserIndex()

◆ GetUser()

◆ GetUserGroupName()

◆ GetUserGroupsCount()

◆ GetUserRef()

◆ GetUsersCount()

◆ RenameUser()