Buddy.h

// ===================================================================
//
// Description      
//      Contains the definition of Buddy interface
//
// Revision history
//      Date            Description
//      30-Nov-2012     First version
//
// ===================================================================
#ifndef __Buddy__
#define __Buddy__

#include "../Util/Common.h"
#include "Variables/BuddyVariable.h"

#include <boost/shared_ptr.hpp>             // Boost Asio shared pointer

#if defined(_MSC_VER)
#pragma warning(disable:4786)           // STL library: disable warning 4786; this warning is generated due to a Microsoft bug
#endif
#include <string>                       // STL library: string object
#include <list>                         // STL library: list object 
#include <vector>                       // STL library: vector object
using namespace std;                    // STL library: declare the STL namespace

using namespace Sfs2X::Entities::Variables;

namespace Sfs2X {
namespace Entities {

    class DLLImportExport Buddy
    {
    public:
        virtual long int Id() = 0;

        virtual void Id(long int value) = 0;

        virtual boost::shared_ptr<string> Name() = 0;
        
        virtual bool IsBlocked() = 0;

        virtual void IsBlocked(bool value) = 0;

        virtual bool IsOnline() = 0;
        
        virtual bool IsTemp() = 0;

        virtual boost::shared_ptr<string> State() = 0;
        
        virtual boost::shared_ptr<string> NickName() = 0;
        
        virtual boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > Variables() = 0;
        
        virtual boost::shared_ptr<BuddyVariable> GetVariable(string varName) = 0;
        
        virtual bool ContainsVariable(string varName) = 0;
        
        virtual boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > GetOfflineVariables() = 0;
        
        virtual boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > GetOnlineVariables() = 0;
        
        virtual void SetVariable(boost::shared_ptr<BuddyVariable> bVar) = 0;
        
        virtual void SetVariables(boost::shared_ptr<vector<boost::shared_ptr<BuddyVariable> > > variables) = 0;
        
        virtual void RemoveVariable(string varName) = 0;

        virtual void ClearVolatileVariables() = 0;
    };

}   // namespace Entities
}   // namespace Sfs2X

#endif