SetBuddyVariablesRequest.h

// ===================================================================
//
// Description      
//      Contains the definition of SetBuddyVariablesRequest
//
// Revision history
//      Date            Description
//      30-Nov-2012     First version
//
// ===================================================================
#ifndef __SetBuddyVariablesRequest__
#define __SetBuddyVariablesRequest__

#include "../../Util/Common.h"
#include "../BaseRequest.h"
#include "../../Exceptions/SFSValidationError.h"
#include "../../Entities/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 <list>                         // STL library: list object
#include <string>                       // STL library: string object
using namespace std;                    // STL library: declare the STL namespace

namespace Sfs2X {
namespace Requests {
namespace Buddylist {

    class DLLImportExport SetBuddyVariablesRequest : public BaseRequest
    {
    public:

        // -------------------------------------------------------------------
        // Public methods
        // -------------------------------------------------------------------

        SetBuddyVariablesRequest(boost::shared_ptr<list<boost::shared_ptr<BuddyVariable> > > buddyVariables);

        virtual ~SetBuddyVariablesRequest();

        void Validate(boost::shared_ptr<SmartFox> sfs);

        void Execute(boost::shared_ptr<SmartFox> sfs);

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------
        
        static boost::shared_ptr<string> KEY_BUDDY_NAME;

        static boost::shared_ptr<string> KEY_BUDDY_VARS;

    protected:

        // -------------------------------------------------------------------
        // Protected methods
        // -------------------------------------------------------------------

        // -------------------------------------------------------------------
        // Protected members
        // -------------------------------------------------------------------

    private:

        // -------------------------------------------------------------------
        // Private methods
        // -------------------------------------------------------------------

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
        boost::shared_ptr<list<boost::shared_ptr<BuddyVariable> > > buddyVariables;
    };

}   // namespace Buddylist
}   // namespace Requests
}   // namespace Sfs2X

#endif