ms_http_client_search.hpp

/*
##############################################################################
# file: ms_http_client_search.hpp                                                   #
# 'msparser' toolkit                                                         #
# Represents a task on a Mascot server and can be used to sumbit and track   #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2013 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_http_client_search.hpp $
 * @(#)$Revision: 9f0c123764e41b5a92a31ec7e127cc7e3aa6ce82 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2024-02-01 09:58:21 +0000 $
##############################################################################
 */
 
#ifndef MS_HTTP_CLIENT_SEARCH_HPP
#define MS_HTTP_CLIENT_SEARCH_HPP
 
 
#include <string>
 
namespace matrix_science
{
    class ms_http_helper;
    class ms_http_client_session;
 
 
    class MS_MASCOTRESFILE_API ms_http_client_search :
        public ms_errors
    {
        public:
 
 
            enum SearchStatusCode
            {
                SS_UNKNOWN,             
                SS_ASSIGNED,            
                SS_QUEUED,              
                SS_RUNNING,             
                SS_COMPLETE,            
                SS_ERROR,               
                SS_SEARCH_CONTROL_ERROR 
            };
 
 
            enum UploadResponseCode
            {
                UR_SUCCESS,             
                UR_ACCESS_DENIED,       
                UR_INVALID_TASKID,      
                UR_NO_RESULT_FILENAME,  
                UR_NO_RESULT_FILE,      
                UR_FILE_ALREADY_EXISTS, 
                UR_ERROR                
            };
 
 
            enum DownloadOption
            {
                DO_NORMAL = 0,   
                DO_WITH_IONS = 1 
            };
 
 
            enum ReportTopSpecialValues
            {
                RT_auto = 0, 
                RT_file = -1 
            };
 
#ifndef SWIG
            // C++ STL collection support
            ms_http_client_search();
#endif
            ms_http_client_search(ms_http_client_session & session, const std::string & searchTaskId);
 
            virtual ~ms_http_client_search();
 
            ms_http_client_search(const ms_http_client_search & src);
#ifndef SWIG
            ms_http_client_search& operator=(const ms_http_client_search & right);
#endif
            void copyFrom(const ms_http_client_search * right);
 
 
            std::string sessionId() const { return getSessionID(); }
 
            std::string getSessionID() const;
 
            std::string getSearchTaskID() const;
 
 
            std::string searchTaskId() const { return getSearchTaskID(); }
 
            bool getStatus(SearchStatusCode & returnCode, int & statusValue);
 
#ifndef SWIG
            // Undocumented for Perl compatibility. Unable to return an enum
            bool getStatus(int & returnCodeAsInt, int & statusValue);
 
            bool getResultsFileName(std::string & returnFileName);
 
            bool getStage(std::string & stage, int & step);
#else // SWIG Multiple return values
            bool getStatus(int & OUTPUT, int & OUTPUT);
            bool getResultsFileName(std::string & OUTPUT);
            bool getStage(std::string & OUTPUT, int & OUTPUT);
#endif
 
 
            bool getResultsFilename(std::string & returnFilename) { return getResultsFileName(returnFilename); }
 
            bool downloadResultsFile(std::string filename, ms_http_helper_progress & progress, DownloadOption options = DO_WITH_IONS);
 
            bool downloadResultsFileMSR(std::string filename, ms_http_helper_progress & progress, DownloadOption options = DO_WITH_IONS);
 
            bool downloadDaemonResultsFile(std::string filename, ms_http_helper_progress & progress);
            
            bool downloadPercolatorFile(std::string filename, ms_http_helper_progress & progress);
            
            bool downloadXmlResultsFile(std::string filename, ms_http_helper_progress & progress, int reportTop = RT_auto);
#ifndef SWIG
            bool uploadDistillerXmlResultsFile(std::string filename, UploadResponseCode & responseCode, std::string & responseText);
#else // SWIG Multiple return values
            bool uploadDistillerXmlResultsFile(std::string filename, UploadResponseCode & OUTPUT, std::string & OUTPUT);
#endif
        private:
            // Constructor for a newly submitted search
            ms_http_client_search(ms_http_client_session & session, std::string searchTaskId, const std::string & actionString);
 
            ms_http_client_session * session_;
            std::string searchTaskId_;
            std::string actionString_;
            ms_http_helper_handles postRequestHandles_;
 
        friend class ms_http_client_session; // access to constructor and private member variables when starting a search
    };
 // end of http_client_group
} // namespace matrix_science
 
#endif // MS_HTTP_CLIENT_SEARCH_HPP
 
/*------------------------------- End of File -------------------------------*/