Workspace/Siman-WS/src/org/splat/ws_server/service/salome/SimanSalomeService.java

   1 package org.splat.ws_server.service.salome;
   2
   3 import javax.activation.DataHandler;
   4
   5 /**
   6  * The SimanSalome WebService.
   7  * @author Maria KRUCHININA
   8  *
   9  */
  10 public interface SimanSalomeService {
  11
  12         /** Create the siman-salome.conf file.
  13      * @param studyId the study ID
  14      * @param scenarioId the scenario ID
  15      * @param userId the user ID
  16      * @return the URL location of the siman-salome.conf
  17      */
  18
  19         String createConfigFile(final Long studyId, final Long scenarioId,
  20                         final Long userId);
  21
  22         /**
  23          * Get the server file on client.
  24          * @param fileURL - the file URL
  25          * @return the data handler
  26          */
  27         DataHandler getFile(final String fileURL);
  28
  29         /**
  30          * Put the file from client to server.
  31          * @param dataHandler the data handler
  32          * @param fileName the name of the uploaded file
  33          * @param userId the user ID
  34          * @return the result URL in vault
  35          **/
  36         String /*DataHandler*/ putFile(final DataHandler dataHandler, final String fileName, final Long userId);
  37
  38         /**
  39          * Check in operation.
  40          * @param fileURL - the salome-siman.conf file URL
  41          * @param scenarioId the scenario ID
  42          * @param userId the user ID
  43          **/
  44         String checkIn(final String fileURL, final Long scenarioId, final Long userId);
  45
  46         /**
  47          * Create new study from python - client.
  48          * @param studyName new study name
  49          * @param productName product name
  50          * @param userName creator(user) name
  51          * @param description the study description
  52          * @return string contains information about new study Id
  53          */
  54         String createNewStudy(final String userName, final String studyName, final String productName, final String description);
  55
  56         /**
  57          * Assign the new simulation context to the existing study.
  58          * @param studyId - the target study id.
  59          * @param contextName - new context name.
  60          * @param contextType - new context type.
  61          * @return success or not.
  62          */
  63         String assignSimulationContext(final Long studyId, final String contextType, final String contextName);
  64 }