Tonido::Data::GuestUserManager Class Reference

Manages GuestUsers. More...

List of all members.

Public Types
typedef boost::shared_ptr < GuestUserManager >	SharedPtr
Public Member Functions
Ctors & Dtors
	GuestUserManager ()
	Ctor.
	~GuestUserManager ()
	Dtor.
GuestUser Management
bool	guestUserAdd (GuestUser::SharedPtr &a_guestUser)
	Add a new GuestUser.
bool	guestUserUpdate (GuestUser::SharedPtr &a_guestUser)
	Update the GuestUser.
bool	guestUserRemove (int a_userID)
	Removes a GuestUser.
std::string	getUsersXML ()
	Get the GuestUserList.
int	getGuestUserId (const std::string &a_userName)
	Get the GuestUserId.
int	getGuestUserId (const std::string &a_userName, const std::string &a_password, bool a_isHashed=false)
	Get the getGuestUserId.
void	guestUserCollectionGet (Tonido::Data::GuestUser::Collection &a_collection)
	Get the GuestUserList.
Tonido::Data::GuestUser::SharedPtr	guestUserGet (int a_userId)
	Get the GuestUserList.
bool	doesGuestUserExist (const std::string &a_userName)
	Get the doesGuestUserExist.
bool	doesGuestUserExist (const std::string &a_userName, int a_userId)
	Get the doesGuestUserExist.
bool	doesGuestUserExist (int a_userId)
	Get the doesGuestUserExist.

---

Detailed Description

Manages GuestUsers.

---

Constructor & Destructor Documentation

Tonido::Data::GuestUserManager::GuestUserManager

(

)

Ctor.

details if needed ...

Tonido::Data::GuestUserManager::~GuestUserManager

(

)

Dtor.

details if needed ...

---

Member Function Documentation

bool Tonido::Data::GuestUserManager::doesGuestUserExist

(

const std::string &

a_userName

)

Get the doesGuestUserExist.

Parameters:

[int]

guest username

Returns:

status if user exists already

bool Tonido::Data::GuestUserManager::doesGuestUserExist	(	const std::string &	a_userName,
		int	a_userId
	)

Get the doesGuestUserExist.

Parameters:

[string]

guest username [int] userid

Returns:

status if user exists already

bool Tonido::Data::GuestUserManager::doesGuestUserExist

(

int

a_userId

)

Get the doesGuestUserExist.

Parameters:

[int]

guest userid

Returns:

status if user exists already

int Tonido::Data::GuestUserManager::getGuestUserId

(

const std::string &

a_userName

)

Get the GuestUserId.

Parameters:

[in]

guest

username

Returns:

guest user id

int Tonido::Data::GuestUserManager::getGuestUserId	(	const std::string &	a_userName,
		const std::string &	a_password,
		bool	a_isHashed = false
	)

Get the getGuestUserId.

Parameters:

[in]

guest

username and password

Returns:

guest userid

std::string Tonido::Data::GuestUserManager::getUsersXML

(

)

Get the GuestUserList.

Parameters:

[out]

a_collection

collection of groups

Returns:

All groups that current Peer is part of

bool Tonido::Data::GuestUserManager::guestUserAdd

(

GuestUser::SharedPtr &

a_guestUser

)

Add a new GuestUser.

Parameters:

[in,out]

a_guestUser

guestUser Object

Returns:

true on successs, false otherwise

void Tonido::Data::GuestUserManager::guestUserCollectionGet

(

Tonido::Data::GuestUser::Collection &

a_collection

)

Get the GuestUserList.

Parameters:

[out]

a_collection

collection of groups

Returns:

nothing

Tonido::Data::GuestUser::SharedPtr Tonido::Data::GuestUserManager::guestUserGet

(

int

a_userId

)

Get the GuestUserList.

Parameters:

[int]

guest userid

Returns:

GuestUser

bool Tonido::Data::GuestUserManager::guestUserRemove

(

int

a_userID

)

Removes a GuestUser.

Parameters:

[in]

a_UserID

of the guest User to remove

Returns:

true on successs, false otherwise

bool Tonido::Data::GuestUserManager::guestUserUpdate

(

GuestUser::SharedPtr &

a_guestUser

)

Update the GuestUser.

Parameters:

[in,out]

a_guestUser

guestUser Object

Returns:

true on successs, false otherwise