Default document types mappings are moved from application settings (my.xml) to proje...

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

diff --git a/Workspace/Siman-Common/src/org/splat/service/PublicationService.java b/Workspace/Siman-Common/src/org/splat/service/PublicationService.java
index 9abcf754aa078c50a6faaf70b5d0383e409d9fb4..e30099e270186f67a14f9e5068abd6d62edd30d3 100644 (file)
--- a/Workspace/Siman-Common/src/org/splat/service/PublicationService.java
+++ b/Workspace/Siman-Common/src/org/splat/service/PublicationService.java
@@ -50,30 +50,47 @@ public interface PublicationService {
 
        /**
         * Create a new version of the document.
-        * @param step the study step where the document is published
-        * @param user the current user
-        * @param filename the new version file name
-        * @param docIndex the publication id
-        * @param docver new document version string, empty for external documents
-        * @param summary the version comment
-        * @param state the new state of the document
-        * @param date the new modification date
-        * @param docuses the array of documents ids used by the versioned document
-        * @param docusedby the array of impacted documents ids
-        * @throws MissedPropertyException if some mandatory property is missed 
-        * @throws InvalidPropertyException if some property has invalid value
-        * @throws MultiplyDefinedException if some property occurs several times
-        * @throws IOException if file moving is failed
-        * @throws MismatchException if step number in properties doesn't match to the given step
-        * @throws NotApplicableException if publication's document is undefined
-        * @throws InterruptedException by Thread.sleep if interrupted
+        * 
+        * @param step
+        *            the study step where the document is published
+        * @param user
+        *            the current user
+        * @param filename
+        *            the new version file name
+        * @param docIndex
+        *            the publication id
+        * @param docver
+        *            new document version string, empty for external documents
+        * @param summary
+        *            the version comment
+        * @param state
+        *            the new state of the document
+        * @param date
+        *            the new modification date
+        * @param docuses
+        *            the array of documents ids used by the versioned document
+        * @param docusedby
+        *            the array of impacted documents ids
+        * @throws MissedPropertyException
+        *             if some mandatory property is missed
+        * @throws InvalidPropertyException
+        *             if some property has invalid value
+        * @throws MultiplyDefinedException
+        *             if some property occurs several times
+        * @throws IOException
+        *             if file moving is failed
+        * @throws MismatchException
+        *             if step number in properties doesn't match to the given step
+        * @throws NotApplicableException
+        *             if publication's document is undefined
+        * @throws InterruptedException
+        *             by Thread.sleep if interrupted
         */
-       void versionDocument(Step step, User user, String filename,
-                       long docIndex, String docver, String summary, ProgressState state,
-                       Date date, String[] docuses, long[] docusedby)
-                       throws MissedPropertyException, InvalidPropertyException,
-                       MultiplyDefinedException, IOException, MismatchException,
-                       NotApplicableException, InterruptedException;
+       void versionDocument(Step step, User user, String filename, long docIndex,
+                       String docver, String summary, ProgressState state, Date date,
+                       String[] docuses, long[] docusedby) throws MissedPropertyException,
+                       InvalidPropertyException, MultiplyDefinedException, IOException,
+                       MismatchException, NotApplicableException, InterruptedException;
 
        /**
         * Returns the study Step into which the document version referenced by this publication has been published.
@@ -173,7 +190,7 @@ public interface PublicationService {
        /**
         * Publishes the document referenced by this publication into the owner Project Element under the given state, the revision number of
         * the document being automatically set accordingly. If the given state is In-Draft and the document is final result of the owner study,
-        * this automatically promotes the study to In-Draft.
+        * this automatically promotes the study to In-Draft. The old publication is removed from the scenario.
         * 
         * @param aPublication
         *            the document publication
@@ -192,7 +209,7 @@ public interface PublicationService {
         * of the referenced document is supposed being automatically set according to the given revision number, but, due to the versioning
         * scheme, as it is not possible to differentiate In-Work and In-Draft states, this function has been deprecated (it is currently used
         * only for the need of integration of Microsoft Office which anyway has to be redesigned). <br/> Note: in the context of branch
-        * versioning, the given revision may be modified by an update of the branch name.
+        * versioning, the given revision may be modified by an update of the branch name. The old publication is removed from the scenario.
         * 
         * @param aPublication
         *            the document publication