Modifications done to respect PMD rules. Versioning a document is fixed. Validation...

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

diff --git a/Workspace/Siman-Common/src/org/splat/service/StudyService.java b/Workspace/Siman-Common/src/org/splat/service/StudyService.java
index 50595523194a58b0341c0e1633b57632ccb131b2..9ba72257473e60635760ff54dcaf42b82dd78b96 100644 (file)
--- a/Workspace/Siman-Common/src/org/splat/service/StudyService.java
+++ b/Workspace/Siman-Common/src/org/splat/service/StudyService.java
@@ -14,7 +14,6 @@ import java.util.List;
 import org.splat.dal.bo.kernel.User;
 import org.splat.dal.bo.som.DocumentType;
 import org.splat.dal.bo.som.Publication;
-import org.splat.dal.bo.som.Scenario;
 import org.splat.dal.bo.som.SimulationContext;
 import org.splat.dal.bo.som.Study;
 import org.splat.dal.bo.som.ValidationCycle;
@@ -38,7 +37,7 @@ public interface StudyService {
         *            the study
         * @return incremented docount value
         */
-       public int generateLocalIndex(Study aStudy);
+       int generateLocalIndex(Study aStudy);
 
        /**
         * Get study by its id.
@@ -47,7 +46,7 @@ public interface StudyService {
         *            the study id
         * @return found study or null
         */
-       public Study selectStudy(long index);
+       Study selectStudy(long index);
 
        /**
         * Create a new study.
@@ -62,7 +61,7 @@ public interface StudyService {
         * @throws MultiplyDefinedException
         *             if some property is defined several times
         */
-       public Study createStudy(Study.Properties sprop)
+       Study createStudy(Study.Properties sprop)
                        throws MissedPropertyException, InvalidPropertyException,
                        MultiplyDefinedException;
 
@@ -81,7 +80,7 @@ public interface StudyService {
         * @throws MultiplyDefinedException
         *             if some property occurs several times
         */
-       public SimulationContext addProjectContext(Study aStudy,
+       SimulationContext addProjectContext(Study aStudy,
                        SimulationContext.Properties cprop) throws MissedPropertyException,
                        InvalidPropertyException, MultiplyDefinedException;
 
@@ -94,7 +93,7 @@ public interface StudyService {
         *            the simulation context to add
         * @return the added simulation context
         */
-       public SimulationContext addProjectContext(Study aStudy,
+       SimulationContext addProjectContext(Study aStudy,
                        SimulationContext context);
 
        /**
@@ -106,7 +105,7 @@ public interface StudyService {
         *            the simulation context to remove
         * @return true if removing succeeded
         */
-       public boolean removeProjectContext(Study aStudy, SimulationContext context);
+       boolean removeProjectContext(Study aStudy, SimulationContext context);
 
        /**
         * Demotes this study from In-Check to In-Draft then In-Work states. This function is called internally when demoting the final result
@@ -116,7 +115,7 @@ public interface StudyService {
         *            the study to demote
         * @return true if the demotion succeeded.
         */
-       public boolean demote(Study aStudy);
+       boolean demote(Study aStudy);
 
        /**
         * Promotes this study from In-Work to In-Draft then In-Check and APPROVED states. This function is called internally when promoting the
@@ -126,7 +125,7 @@ public interface StudyService {
         *            the study to promote
         * @return true if the promotion succeeded.
         */
-       public boolean promote(Study aStudy);
+       boolean promote(Study aStudy);
 
        /**
         * Add a contributor to the study.
@@ -137,7 +136,7 @@ public interface StudyService {
         *            the contributor
         * @return true if addition succeeded
         */
-       public boolean addContributor(Study aStudy, User user);
+       boolean addContributor(Study aStudy, User user);
 
        /**
         * Remove contributors from the study.
@@ -148,7 +147,7 @@ public interface StudyService {
         *            contributor(s)
         * @return true if removing succeeded
         */
-       public boolean removeContributor(Study aStudy, User... users);
+       boolean removeContributor(Study aStudy, User... users);
 
        /**
         * Set a validation cycle for documents of the given type in the given study.
@@ -160,7 +159,7 @@ public interface StudyService {
         * @param vprop
         *            validation cycle properties
         */
-       public void setValidationCycle(Study aStudy, DocumentType type,
+       void setValidationCycle(Study aStudy, DocumentType type,
                        ValidationCycle.Properties vprop);
 
        /**
@@ -171,7 +170,7 @@ public interface StudyService {
         * @return true if the move succeeded.
         * @see #isPublic()
         */
-       public boolean moveToPublic(Study aStudy);
+       boolean moveToPublic(Study aStudy);
 
        /**
         * Moves this study from the Public to the Reference area of the repository. For being moved to the Reference area, the study must
@@ -184,7 +183,7 @@ public interface StudyService {
         * @see #isPublic()
         * @see Publication#approve(Date)
         */
-       public boolean moveToReference(Study aStudy);
+       boolean moveToReference(Study aStudy);
 
        /**
         * Update a study.
@@ -197,7 +196,7 @@ public interface StudyService {
         * @throws InvalidPropertyException
         *             if some property doesn't exist
         */
-       public boolean update(Study aStudy, Properties sprop)
+       boolean update(Study aStudy, Properties sprop)
                        throws InvalidPropertyException;
 
        /**
@@ -206,7 +205,7 @@ public interface StudyService {
         * @param aStudy
         *            the study
         */
-       public void loadWorkflow(Study aStudy);
+       void loadWorkflow(Study aStudy);
 
        /**
         * Returns the validation cycle of the given document type.
@@ -217,7 +216,7 @@ public interface StudyService {
         *            the document type being subject of validation
         * @return the validation cycle of the document, or null if not defined.
         */
-       public ValidationCycle getValidationCycleOf(Study aStudy, DocumentType type);
+       ValidationCycle getValidationCycleOf(Study aStudy, DocumentType type);
 
        /**
         * Checks if the given user participates to this study. The Study staff includes the author and contributors.
@@ -229,7 +228,7 @@ public interface StudyService {
         * @return true if the given user is actor of this study.
         * @see #getContributors()
         */
-       public boolean isStaffedBy(Study aStudy, User user);
+       boolean isStaffedBy(Study aStudy, User user);
 
        /**
         * Checks if the given user is actor of this study. Actors include contributors, reviewers and approvers.
@@ -241,7 +240,7 @@ public interface StudyService {
         * @return true if the given user is actor of this study.
         * @see #getActors()
         */
-       public boolean hasActor(Study aStudy, User user);
+       boolean hasActor(Study aStudy, User user);
 
        /**
         * Returns unmodifiable initialized transient list of contributors of this study.
@@ -250,5 +249,5 @@ public interface StudyService {
         *            the study
         * @return the unmodifiable not null transient list of contributors of this study
         */
-       public List<User> getContributors(Study aStudy);
+       List<User> getContributors(Study aStudy);
 }