createStudy method is added for calling from Python.

[tools/siman.git] / Workspace / Siman-Common / src / org / splat / service / ScenarioService.java

diff --git a/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java b/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java
index 200d3a94d0106bd521df53a0ef65f967151f3435..e00d67869d2f6ff142cbf0aeed2449b513a1f40e 100644 (file)
--- a/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java
+++ b/Workspace/Siman-Common/src/org/splat/service/ScenarioService.java
@@ -41,6 +41,29 @@ public interface ScenarioService {
         */
        List<StepDTO> getScenarioInfo(long scenarioId);
 
+       /**
+        * Create a new study.
+        * 
+        * @param username
+        *            user login
+        * @param title
+        *            study title
+        * @param productName
+        *            study product simulation context value
+        * @param description
+        *            study summary
+        * @return the created study id
+        * @throws InvalidPropertyException
+        *             if an invalid value is passed to a property
+        * @throws MissedPropertyException
+        *             if a mandatory property is missed
+        * @throws MultiplyDefinedException
+        *             if some property is defined several times
+        */
+       long createStudy(final String username, final String title,
+                       final String productName, final String description)
+                       throws InvalidPropertyException, MissedPropertyException, MultiplyDefinedException;
+
        /**
         * Create a new study with one scenario and "product" simulation context.
         * 
@@ -73,7 +96,7 @@ public interface ScenarioService {
         * @throws MissedPropertyException
         *             if a mandatory property is missed
         * @throws InvalidPropertyException
-        *             if some property doesn't exist
+        *             if an invalid value is passed to a property
         * @throws MultiplyDefinedException
         *             if some property occurs several times
         */
@@ -92,7 +115,7 @@ public interface ScenarioService {
         * @throws MissedPropertyException
         *             if a mandatory property is missed
         * @throws InvalidPropertyException
-        *             if some property doesn't exist
+        *             if an invalid value is passed to a property
         * @throws MultiplyDefinedException
         *             if some property is defined several times
         */