Tonido::Data::FavoriteRecordManager Class Reference

Manages FavoriteRecords. More...

List of all members.

Public Types
typedef boost::shared_ptr < FavoriteRecordManager >	SharedPtr
Public Member Functions
Ctors & Dtors
	FavoriteRecordManager ()
	Ctor.
	~FavoriteRecordManager ()
	Dtor.
Favorite Management
bool	addFavoriteList (const std::string &a_name, int &a_id)
	Add a new FavoriteList.
bool	doesFavoriteListExist (const std::string &a_name, int &a_id)
	Does FavoriteList exist.
bool	updateFavoriteList (int id, const std::string &a_name)
	Update a FavoriteList.
bool	deleteFavoriteList (int id)
	Delete a FavoriteList.
bool	setFavorite (int a_id, const std::string &a_name, int a_order)
	Add a new FavoriteRecord.
bool	doesFavoriteExist (int a_id, const std::string &a_name)
	Does Favorite Exist.
bool	unsetFavorite (int a_id, const std::string &a_name)
	Removes a FavoriteRecord from a Favorite List.
bool	updateFavoriteOrder (int a_id, const std::string &a_name, int a_order)
	Updates a favorite order value.
std::string	getFavoriteRecordsXML (int a_id, const std::string &a_filter)
	Gets list of favorites in a specific favorite list.
std::string	getFavoriteListsXML ()
	Gets list of favorite lists.

---

Detailed Description

Manages FavoriteRecords.

---

Constructor & Destructor Documentation

Tonido::Data::FavoriteRecordManager::FavoriteRecordManager

(

)

Ctor.

details if needed ...

Tonido::Data::FavoriteRecordManager::~FavoriteRecordManager

(

)

Dtor.

details if needed ...

---

Member Function Documentation

bool Tonido::Data::FavoriteRecordManager::addFavoriteList	(	const std::string &	a_name,
		int &	a_id
	)

Add a new FavoriteList.

Parameters:

[in]

a_name

name of the Favorite List

Returns:

true on successs, false otherwise

bool Tonido::Data::FavoriteRecordManager::deleteFavoriteList

(

int

id

)

Delete a FavoriteList.

Parameters:

[in]

id

of the favorite list object to delete

Returns:

true on successs, false otherwise

bool Tonido::Data::FavoriteRecordManager::doesFavoriteExist	(	int	a_id,
		const std::string &	a_name
	)

Does Favorite Exist.

Parameters:

[in]

a_FavoriteID

of the FavoriteRecord to remove

Returns:

true if exists, false otherwise

bool Tonido::Data::FavoriteRecordManager::doesFavoriteListExist	(	const std::string &	a_name,
		int &	a_id
	)

Does FavoriteList exist.

Parameters:

[in]

a_name

name of the Favorite List

Returns:

true if exists, false otherwise

std::string Tonido::Data::FavoriteRecordManager::getFavoriteListsXML

(

)

Gets list of favorite lists.

Returns:

true on successs, false otherwise

std::string Tonido::Data::FavoriteRecordManager::getFavoriteRecordsXML	(	int	a_id,
		const std::string &	a_filter
	)

Gets list of favorites in a specific favorite list.

Parameters:

[in]

a_id

ID of the FavoriteList to get records for

Returns:

true on successs, false otherwise

bool Tonido::Data::FavoriteRecordManager::setFavorite	(	int	a_id,
		const std::string &	a_name,
		int	a_order
	)

Add a new FavoriteRecord.

Parameters:

[in,out]

a_FavoriteRecord

FavoriteRecord Object to add

Returns:

true on successs, false otherwise

bool Tonido::Data::FavoriteRecordManager::unsetFavorite	(	int	a_id,
		const std::string &	a_name
	)

Removes a FavoriteRecord from a Favorite List.

Parameters:

[in]

a_FavoriteID

of the FavoriteRecord to remove

Returns:

true on successs, false otherwise

bool Tonido::Data::FavoriteRecordManager::updateFavoriteList	(	int	id,
		const std::string &	a_name
	)

Update a FavoriteList.

Parameters:

[in]

id

id of the Favorite List Object

Returns:

true on successs, false otherwise

bool Tonido::Data::FavoriteRecordManager::updateFavoriteOrder	(	int	a_id,
		const std::string &	a_name,
		int	a_order
	)

Updates a favorite order value.

Parameters:

[in]

a_FavoriteID

of the FavoriteRecord to remove

Returns:

true on successs, false otherwise