Added getPublishInvestigations to interface. Refs #9223.

mantidproject · Apr 1, 2014 · 4b643b1 · 4b643b1
1 parent e586877
commit 4b643b1
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 0 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/ICatalogInfoService.h b/Code/Mantid/Framework/API/inc/MantidAPI/ICatalogInfoService.h
@@ -45,6 +45,8 @@ namespace Mantid
         virtual const std::string getDownloadURL(const long long&)=0;
         /// Obtain the url to upload a file to.
         virtual const std::string getUploadURL(const std::string&,const std::string&,const std::string&)=0;
+        /// Obtains the investigations that the user can publish to and saves related information to a workspace..
+        virtual ITableWorkspace_sptr getPublishInvestigations()=0;
     };
 
     typedef boost::shared_ptr<ICatalogInfoService> ICatalogInfoService_sptr;

diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Catalog.h b/Code/Mantid/Framework/ICat/inc/MantidICat/ICat3/ICat3Catalog.h
@@ -71,6 +71,8 @@ namespace Mantid
           const std::string &investigationID, const std::string &createFileName, const std::string &dataFileDescription);
       /// keep alive
       virtual void keepAlive();
+      /// Obtains the investigations that the user can publish to and saves related information to a workspace.
+      virtual API::ITableWorkspace_sptr getPublishInvestigations();
 
     private:
       /// The helper class that accesses ICAT functionality.

diff --git a/Code/Mantid/Framework/ICat/inc/MantidICat/ICat4/ICat4Catalog.h b/Code/Mantid/Framework/ICat/inc/MantidICat/ICat4/ICat4Catalog.h
@@ -66,6 +66,8 @@ namespace Mantid
         /// get URL of where to PUT (publish) files.
         virtual const std::string getUploadURL(
             const std::string &investigationID, const std::string &createFileName, const std::string &dataFileDescription);
+        /// Obtains the investigations that the user can publish to and saves related information to a workspace.
+        virtual API::ITableWorkspace_sptr getPublishInvestigations();
         /// Keep current session alive
         virtual void keepAlive();
 

diff --git a/Code/Mantid/Framework/ICat/src/ICat3/ICat3Catalog.cpp b/Code/Mantid/Framework/ICat/src/ICat3/ICat3Catalog.cpp
@@ -143,5 +143,15 @@ namespace Mantid
     {
     }
 
+    /**
+     * Obtains the investigations that the user can publish
+     * to and saves related information to a workspace.
+     * @return A workspace containing investigation information the user can publish to.
+     */
+    API::ITableWorkspace_sptr ICat3Catalog::getPublishInvestigations()
+    {
+      throw std::runtime_error("Publishing is not supported in ICat3Catalog.");
+    }
+
   }
 }
diff --git a/Code/Mantid/Framework/ICat/src/ICat4/ICat4Catalog.cpp b/Code/Mantid/Framework/ICat/src/ICat4/ICat4Catalog.cpp
@@ -777,6 +777,14 @@ namespace Mantid
       return url;
     }
 
+    /**
+     * Obtains the investigations that the user can publish
+     * to and saves related information to a workspace.
+     * @return A workspace containing investigation information the user can publish to.
+     */
+    API::ITableWorkspace_sptr ICat4Catalog::getPublishInvestigations()
+    {
+    }
 
     /**
      * Search the archive & obtain the dataset ID for a specific investigation.