FindUsersRequest.h

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

#include "../Util/Common.h"
#include "BaseRequest.h"
#include "../Entities/User.h"
#include "../Entities/Room.h"
#include "../Entities/Match/MatchExpression.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

using namespace Sfs2X::Entities::Match;

namespace Sfs2X {
namespace Requests {

    class DLLImportExport FindUsersRequest : public BaseRequest
    {
    public:

        // -------------------------------------------------------------------
        // Public methods
        // -------------------------------------------------------------------
        void Init(boost::shared_ptr<MatchExpression> expr);
        void Init(boost::shared_ptr<MatchExpression> expr, boost::shared_ptr<Room> target, long int limit);
        void Init(boost::shared_ptr<MatchExpression> expr, string target, long int limit);

        FindUsersRequest(boost::shared_ptr<MatchExpression> expr);

        FindUsersRequest(boost::shared_ptr<MatchExpression> expr, boost::shared_ptr<Room> target);

        FindUsersRequest(boost::shared_ptr<MatchExpression> expr, boost::shared_ptr<Room> target, long int limit);

        FindUsersRequest(boost::shared_ptr<MatchExpression> expr, string target);

        FindUsersRequest(boost::shared_ptr<MatchExpression> expr, string target, long int limit);

        virtual ~FindUsersRequest();

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

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

        // -------------------------------------------------------------------
        // Public members
        // -------------------------------------------------------------------
        
        static boost::shared_ptr<string> KEY_EXPRESSION;
        
        static boost::shared_ptr<string> KEY_GROUP;
        
        static boost::shared_ptr<string> KEY_ROOM;
            
        static boost::shared_ptr<string> KEY_LIMIT;
        
        static boost::shared_ptr<string> KEY_FILTERED_USERS;

    protected:

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

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

    private:

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

        // -------------------------------------------------------------------
        // Private members
        // -------------------------------------------------------------------
        boost::shared_ptr<MatchExpression> matchExpr;
        boost::shared_ptr<Room> targetRoom;
        boost::shared_ptr<string> targetString;
        long int limit;
    };

}   // namespace Requests
}   // namespace Sfs2X

#endif