fix: Refactor process addon - EXO-79327

This change will do some refactoring on the process addon, renaming, intoducing spring...

Author: mkrout

processes-api/src/main/java/org/exoplatform/processes/model/Work.java

@@ -66,21 +66,21 @@ public class Work {
   private List<Attachment> attachments;
 
   /**
-   * constructor for Work task object
+   * constructor for request task object
    *
-   * @param id Work id
-   * @param title Work title
-   * @param description Work description
-   * @param status Work task status
-   * @param completed Work task completed property
-   * @param createdBy Work task creator
-   * @param createdDate Work task creation date
-   * @param startDate Work task start date
-   * @param endDate Work task end date
-   * @param dueDate Work task due date
-   * @param isDraft When the object is a draft object, which will be used to create the work
-   * @param draftId The already saved draft id, which will be deleted once the work created from the draft
-   * @param projectId Work task project
+   * @param id request id
+   * @param title request title
+   * @param description request description
+   * @param status request task status
+   * @param completed request task completed property
+   * @param createdBy request task creator
+   * @param createdDate request task creation date
+   * @param startDate request task start date
+   * @param endDate request task end date
+   * @param dueDate request task due date
+   * @param isDraft When the object is a draft object, which will be used to create the request
+   * @param draftId The already saved draft id, which will be deleted once the request created from the draft
+   * @param projectId request task project
    */
   public Work(long id,
                   String title,

…/service/ProcessesAttachmentService.java …es/service/ProcessAttachmentService.javaprocesses-api/src/main/java/org/exoplatform/processes/service/ProcessesAttachmentService.java renamed to processes-api/src/main/java/org/exoplatform/processes/service/ProcessAttachmentService.java processes-api/src/main/java/org/exoplatform/processes/service/ProcessesAttachmentService.java renamed to processes-api/src/main/java/org/exoplatform/processes/service/ProcessAttachmentService.java

@@ -1,10 +1,10 @@
 package org.exoplatform.processes.service;
 
-import org.exoplatform.services.attachments.model.Attachment;
-
 import java.util.List;
 
-public interface ProcessesAttachmentService {
+import org.exoplatform.services.attachments.model.Attachment;
+
+public interface ProcessAttachmentService {
 
     /**
      * Links a list of attachments to entity

processes-api/src/main/java/org/exoplatform/processes/service/ProcessService.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright (C) 2021 eXo Platform SAS
+ *  
+ *  This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <gnu.org/licenses>.
+ */
+package org.exoplatform.processes.service;
+
+import java.io.IOException;
+import java.util.List;
+
+import org.exoplatform.commons.exception.ObjectNotFoundException;
+import org.exoplatform.commons.file.services.FileStorageException;
+import org.exoplatform.processes.model.*;
+import org.exoplatform.social.core.identity.model.Identity;
+
+public interface ProcessService {
+
+  /**
+   * Retrieves a list of accessible Processes, for a selected user, by applying
+   * the designated filter. The returned results will be of type
+   * {@link WorkFlow} only. The ownerId of filter object will be used to select
+   * the list of accessible processes to retrieve.
+   * 
+   * @param filter {@link ProcessesFilter} that contains filtering criteria
+   * @param offset Offset of the result list
+   * @param limit Limit of the result list
+   * @param userIdentityId {@link Identity} technical identifier of the user
+   *          acessing files
+   * @return {@link List} of {@link WorkFlow}
+   * @throws IllegalAccessException when the user isn't allowed to access
+   *           documents of the designated ownerId
+   */
+  List<WorkFlow> getWorkFlows(ProcessesFilter filter,
+                                    int offset,
+                                    int limit,
+                                    long userIdentityId) throws IllegalAccessException;
+
+
+  int countWorkFlows(ProcessesFilter filter,
+                     long userIdentityId) throws IllegalAccessException;
+
+  WorkFlow getWorkFlow(long id,
+                       long userIdentityId) throws IllegalAccessException, ObjectNotFoundException;
+
+  WorkFlow getWorkFlow(long id) throws IllegalAccessException, ObjectNotFoundException;
+
+  WorkFlow createWorkFlow(WorkFlow workFlow, long userId) throws IllegalAccessException;
+
+  WorkFlow updateWorkFlow(WorkFlow workFlow,
+                                long userId) throws IllegalArgumentException, ObjectNotFoundException, IllegalAccessException;
+
+
+  WorkFlow getWorkFlowByProjectId(long projectId, long userId) throws IllegalAccessException, ObjectNotFoundException;
+
+  WorkFlow getWorkFlowByProjectId(long projectId) throws ObjectNotFoundException;
+
+  /**
+   * Delete a workflow by its given Id.
+   *
+   * @param workflowId : workflow id
+   * @param userId user id
+   */
+  void deleteWorkflowById(Long workflowId, long userId) throws IllegalAccessException, ObjectNotFoundException;
+
+  /**
+   * @param projectId: Tasks project id
+   * @param isCompleted: filter by completed and uncompleted tasks
+   * @param userId user id
+   * @return Filtered tasks count
+   * @throws Exception
+   */
+  int countWorksByWorkflow(Long projectId, long userId, Boolean isCompleted) throws Exception;
+
+  /**
+   * Retrieves the list of available statuses in all workflows
+   *
+   * @return {@link List} of {@link WorkStatus}
+   */
+  List<WorkStatus> getAvailableWorkStatuses();
+
+
+  /**
+   * Retrieves an illustration image by its given id
+   *
+   * @param illustrationId illustration file id
+   * @param userId user id
+   * @return {@link IllustrativeAttachment}
+   * @throws FileStorageException
+   * @throws ObjectNotFoundException
+   */
+  IllustrativeAttachment getIllustrationImageById(Long illustrationId,
+                                                  long userId) throws FileStorageException,
+                                                                       ObjectNotFoundException,
+                                                                       IOException;
+
+  boolean canAccessProcess(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
+
+  boolean canAddProcess(org.exoplatform.services.security.Identity identity);
+
+  boolean canEditProcess(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
+
+  boolean canDeleteProcess(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
+}

…/processes/service/ProcessesService.java …rm/processes/service/RequestService.javaprocesses-api/src/main/java/org/exoplatform/processes/service/ProcessesService.java renamed to processes-api/src/main/java/org/exoplatform/processes/service/RequestService.java processes-api/src/main/java/org/exoplatform/processes/service/ProcessesService.java renamed to processes-api/src/main/java/org/exoplatform/processes/service/RequestService.java

@@ -16,49 +16,13 @@
  */
 package org.exoplatform.processes.service;
 
-import java.io.IOException;
 import java.util.List;
 
 import org.exoplatform.commons.exception.ObjectNotFoundException;
-import org.exoplatform.commons.file.services.FileStorageException;
 import org.exoplatform.processes.model.*;
-import org.exoplatform.social.core.identity.model.Identity;
 
-public interface ProcessesService {
+public interface RequestService {
 
-  /**
-   * Retrieves a list of accessible WorkFlows, for a selected user, by applying
-   * the designated filter. The returned results will be of type
-   * {@link WorkFlow} only. The ownerId of filter object will be used to select
-   * the list of accessible WorkFlows to retrieve.
-   * 
-   * @param filter {@link ProcessesFilter} that contains filtering criteria
-   * @param offset Offset of the result list
-   * @param limit Limit of the result list
-   * @param userIdentityId {@link Identity} technical identifier of the user
-   *          acessing files
-   * @return {@link List} of {@link WorkFlow}
-   * @throws IllegalAccessException when the user isn't allowed to access
-   *           documents of the designated ownerId
-   */
-  List<WorkFlow> getWorkFlows(ProcessesFilter filter,
-                                    int offset,
-                                    int limit,
-                                    long userIdentityId) throws IllegalAccessException;
-
-
-  int countWorkFlows(ProcessesFilter filter,
-                     long userIdentityId) throws IllegalAccessException;
-
-  WorkFlow getWorkFlow(long id,
-                       long userIdentityId) throws IllegalAccessException;
-
-  WorkFlow getWorkFlow(long id) throws IllegalAccessException;
-
-  WorkFlow createWorkFlow(WorkFlow workFlow, long userId) throws IllegalAccessException;
-
-  WorkFlow updateWorkFlow(WorkFlow workFlow,
-                                long userId) throws IllegalArgumentException, ObjectNotFoundException, IllegalAccessException;
 
   /**
    * Retrieves list of filtered works
@@ -72,9 +36,6 @@ WorkFlow updateWorkFlow(WorkFlow workFlow,
    */
   List<Work> getWorks(long userIdentityId, WorkFilter workFilter, int offset, int limit) throws Exception;
 
-  WorkFlow getWorkFlowByProjectId(long projectId, long userId) throws IllegalAccessException;
-
-  WorkFlow getWorkFlowByProjectId(long projectId);
 
   /**
    * Creates a work from new work object or from exiting work draft
@@ -84,27 +45,11 @@ WorkFlow updateWorkFlow(WorkFlow workFlow,
    * @return {@link Work}
    * @throws IllegalAccessException
    */
-  Work createWork(Work work, long userId) throws IllegalAccessException;
+  Work createWork(Work work, long userId) throws IllegalAccessException, ObjectNotFoundException;
 
   Work updateWork(Work work, long userId) throws IllegalArgumentException,
             ObjectNotFoundException,
             IllegalAccessException;
-  /**
-   * Delete a workflow by its given Id.
-   *
-   * @param workflowId : workflow id
-   * @param userId user id
-   */
-  void deleteWorkflowById(Long workflowId, long userId) throws IllegalAccessException, ObjectNotFoundException;
-
-  /**
-   * @param projectId: Tasks project id
-   * @param isCompleted: filter by completed and uncompleted tasks
-   * @param userId user id
-   * @return Filtered tasks count
-   * @throws Exception
-   */
-  int countWorksByWorkflow(Long projectId, long userId, Boolean isCompleted) throws Exception;
 
   /**
    * Delete a work by its given id.
@@ -167,47 +112,21 @@ Work updateWork(Work work, long userId) throws IllegalArgumentException,
    */
   void deleteWorkDraftById(Long draftId, long userId) throws IllegalAccessException, ObjectNotFoundException;
 
-  /**
-   * Retrieves the list of available statuses in all workflows
-   *
-   * @return {@link List} of {@link WorkStatus}
-   */
-  List<WorkStatus> getAvailableWorkStatuses();
-
   /**
    * Retrieves a Work by its given id
    *
    * @param userId user identity id
    * @param workId Work id
    * @return {@link Work}
    */
-  Work getWorkById(long userId, Long workId) throws IllegalAccessException;
+  Work getWorkById(long userId, Long workId) throws IllegalAccessException, ObjectNotFoundException;
 
-  /**
-   * Retrieves an illustration image by its given id
-   *
-   * @param illustrationId illustration file id
-   * @param userId user id
-   * @return {@link IllustrativeAttachment}
-   * @throws FileStorageException
-   * @throws ObjectNotFoundException
-   */
-  IllustrativeAttachment getIllustrationImageById(Long illustrationId,
-                                                  long userId) throws FileStorageException,
-                                                                       ObjectNotFoundException,
-                                                                       IOException;
-
-  boolean canAccess(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
-
-  boolean canAdd(org.exoplatform.services.security.Identity identity);
-
-  boolean canEdit(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
-
-  boolean canDelete(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
 
   boolean canAddRequest(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
 
   boolean canEditRequest(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
 
   boolean canDeleteRequest(WorkFlow workFlow, org.exoplatform.services.security.Identity identity);
+
+  boolean canCompleteRequest(Work work, org.exoplatform.services.security.Identity identity) throws ObjectNotFoundException;
 }