Sfs2X::Entities::Managers::IUserManager Class Reference

The User Manager interface More...

#include <IUserManager.h>

Inheritance diagram for Sfs2X::Entities::Managers::IUserManager:

Public Member Functions
virtual bool	ContainsUserName (string userName)=0
	Checks if a specific User name exists in the local User list More...
virtual bool	ContainsUserId (long int userId)=0
	Checks if a specific User id exists in the local User list More...
virtual bool	ContainsUser (boost::shared_ptr< User > user)=0
	Checks if a specific User object exists in the local User list More...
virtual boost::shared_ptr< User >	GetUserByName (string userName)=0
	Get a User object from its name More...
virtual boost::shared_ptr< User >	GetUserById (long int userId)=0
	Get a User object from its id More...
virtual long int	UserCount ()=0
	Get the total number of Users More...
virtual boost::shared_ptr< vector< boost::shared_ptr< User > > >	GetUserList ()=0
	Get the full list of Users More...

Detailed Description

The User Manager interface

Member Function Documentation

ContainsUser()

virtual bool Sfs2X::Entities::Managers::IUserManager::ContainsUser ( boost::shared_ptr< User >  user )

pure virtual

Checks if a specific User object exists in the local User list

Parameters

user	Pointer to an User instance

Returns

A boolean

Implemented in Sfs2X::Entities::Managers::SFSUserManager.

ContainsUserId()

virtual bool Sfs2X::Entities::Managers::IUserManager::ContainsUserId ( long int  userId )

pure virtual

Checks if a specific User id exists in the local User list

Parameters

userId

A long integer

Returns

A boolean

Implemented in Sfs2X::Entities::Managers::SFSUserManager.

ContainsUserName()

virtual bool Sfs2X::Entities::Managers::IUserManager::ContainsUserName ( string  userName )

pure virtual

Checks if a specific User name exists in the local User list

Parameters

userName

A string pointer

Returns

A boolean

Implemented in Sfs2X::Entities::Managers::SFSUserManager.

GetUserById()

virtual boost::shared_ptr<User> Sfs2X::Entities::Managers::IUserManager::GetUserById ( long int  userId )

pure virtual

Get a User object from its id

Parameters

userId

A long integer

Returns

Pointer to an User instance

Implemented in Sfs2X::Entities::Managers::SFSUserManager.

GetUserByName()

virtual boost::shared_ptr<User> Sfs2X::Entities::Managers::IUserManager::GetUserByName ( string  userName )

pure virtual

Get a User object from its name

Parameters

userName

A string pointer

Returns

Pointer to an User instance

Implemented in Sfs2X::Entities::Managers::SFSUserManager.

GetUserList()

virtual boost::shared_ptr<vector<boost::shared_ptr<User> > > Sfs2X::Entities::Managers::IUserManager::GetUserList ( )

pure virtual

Get the full list of Users

Returns

A vector of User pointers

Implemented in Sfs2X::Entities::Managers::SFSUserManager.

UserCount()

virtual long int Sfs2X::Entities::Managers::IUserManager::UserCount ( )

pure virtual

Get the total number of Users

Implemented in Sfs2X::Entities::Managers::SFSUserManager.