Fixed data/monsters.dat

[irc/gameservirc.git] / gameserv-2.0 / libgameservgldl / include / GameServ / DataLayer / IPlayerDAO.h

#ifndef __GS__IPlayerDAO_H__\r
#define __GS__IPlayerDAO_H__\r
\r
#include <GameServ/GameLayer/GameObjects/PlayerGO.h>\r
using GameServ::GameLayer::GameObjects::PlayerGO;\r
\r
#include <boost/smart_ptr/shared_ptr.hpp>\r
using boost::shared_ptr;\r
\r
#include <list>\r
using std::list;\r
#include <string>\r
using std::string;\r
\r
namespace GameServ { namespace DataLayer { namespace DataAccessObjects\r
{\r
	//! Interface for Player Data Access Objects \r
	/*! \r
		This is the interface for all Player DAOs.  Each specific datasource\r
		will need to inherit this common interface.\r
	*/\r
	class IPlayerDAO\r
	{\r
	public:\r
		// Ctors, Dtors ///////////////////////////////////////////////////////\r
		IPlayerDAO(void);\r
		virtual ~IPlayerDAO(void);	// Needs to be virtual \r
\r
		//! Get the Player using a unique data/object Id\r
		/*!\r
			\param Id Unique identifier\r
			\return A boost shared pointer to a Player game object if found\r
			otherwise the list is empty.\r
		*/\r
		virtual shared_ptr<PlayerGO> GetById(const string &Id) const = 0;\r
\r
		/*! Get a list of Player Ids by Name\r
		\param Name The partial name of the Player to match against the beginning of a Player name\r
		\return A collection of Player Ids matching the name\r
		*/\r
		virtual list<string> GetIdsByName(const string &Name) const = 0;\r
\r
		//! Function to quickly search to see if an Id exists or not\r
		/*!\r
		\param Id The Id of the game object to search for\r
		\return true if the Id is valid and exists in the data, false otherwise\r
		*/\r
		virtual bool IdExists(const string &Id) const = 0;\r
\r
		virtual void Insert(shared_ptr<PlayerGO> spPlayer) = 0;\r
		virtual void Update(shared_ptr<PlayerGO> spPlayer) = 0;\r
	private:\r
		\r
		\r
	};\r
} } }\r
#endif // __GS__IPlayerDAO_H__\r