Public Types | Public Member Functions | List of all members
iauth::IUsersManager Class Referenceabstract

Provide management of users. More...

#include <IUsersManager.h>

Inheritance diagram for iauth::IUsersManager:
iser::ISerializable istd::IChangeable istd::IPolymorphic iauth::CUsersManagerComp

Public Types

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

Public Member Functions

virtual int GetUsersCount () const =0
 Get number of users in this collection. More...
 
virtual int FindUserIndex (const QString &name) const =0
 Search for user with specified name. More...
 
virtual const CUserGetUser (int index) const =0
 Get user using its index. More...
 
virtual CUserGetUserRef (int index)=0
 Get reference to user object using its index. More...
 
virtual CUserAddUser (const QString &userName)=0
 Add a new user to the user list. More...
 
virtual bool DeleteUser (const QString &userName)=0
 Delete the user with the user name. More...
 
virtual bool RenameUser (int userIndex, const QString &userName)=0
 The method renames the user. More...
 
virtual int GetUserGroupsCount () const =0
 Get number of user groups. More...
 
virtual const QString & GetUserGroupName (int groupIndex) const =0
 Get number of user groups. More...
 

Detailed Description

Provide management of users.

Definition at line 22 of file IUsersManager.h.

Member Enumeration Documentation

Data model change notification flags.

Enumerator
CF_USER_ADDED 
CF_USER_REMOVED 
CF_USER_RENAMED 

Definition at line 28 of file IUsersManager.h.

Member Function Documentation

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

Add a new user to the user list.

Parameters
QStringUsername: 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 NULL.

Implemented in iauth::CUsersManagerComp.

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

Delete the user with the user name.

Parameters
QStringUsername: The user name of the user which shall be deleted.
Returns
true if the user was successfully deleted, otherwise false

Implemented in iauth::CUsersManagerComp.

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.

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

Get user using its index.

Implemented in iauth::CUsersManagerComp.

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

Get number of user groups.

Implemented in iauth::CUsersManagerComp.

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

Get number of user groups.

Implemented in iauth::CUsersManagerComp.

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

Get reference to user object using its index.

Implemented in iauth::CUsersManagerComp.

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

Get number of users in this collection.

Implemented in iauth::CUsersManagerComp.

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
QStringuserIndex: user index.
QStringuserName: 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:

© 2007-2017 Witold Gantzke and Kirill Lepskiy