BanUserRequest.h

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

#include "../Util/Common.h"
#include "BaseRequest.h"
#include "BanMode.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
using namespace std;                    // STL library: declare the STL namespace

namespace Sfs2X {
namespace Requests {

    class DLLImportExport BanUserRequest : public BaseRequest
    {
    public:

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

        BanUserRequest(long int userId);

        BanUserRequest(long int userId, string message);

        BanUserRequest(long int userId, string message, BanMode banMode);

        BanUserRequest(long int userId, string message, BanMode banMode, long int delaySeconds);

        BanUserRequest(long int userId, string message, BanMode banMode, long int delaySeconds, long int durationHours);

        virtual ~BanUserRequest();

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

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

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------

        static boost::shared_ptr<string> KEY_USER_ID;
        
        static boost::shared_ptr<string> KEY_MESSAGE;

        static boost::shared_ptr<string> KEY_DELAY;
        
        static boost::shared_ptr<string> KEY_BAN_MODE;
        
        static boost::shared_ptr<string> KEY_BAN_DURATION_HOURS;        

    protected:

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

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

    private:

        // -------------------------------------------------------------------
        // Private methods
        // -------------------------------------------------------------------
        void Init(long int userId, string message, BanMode banMode, long int delaySeconds, long int durationHours);

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
        long int userId;        
        boost::shared_ptr<string> message;
        long int delay;
        BanMode banMode;
        long int durationHours;
    };

}   // namespace Requests
}   // namespace Sfs2X

#endif