From aaa9d5ed2977d6e081c4e468737227ff660ff1f9 Mon Sep 17 00:00:00 2001
From: Marie Verdonck <maria.verdonck@atmire.com>
Date: Fri, 31 Jan 2020 13:10:42 +0100
Subject: [PATCH] [DS-2646]: javadoc & SUBMIT_EDIT_METADATA to ProcessingAction

---
 .../java/org/dspace/xmlworkflow/state/actions/Action.java     | 4 ++++
 .../xmlworkflow/state/actions/WorkflowActionConfig.java       | 4 ++++
 .../actions/processingaction/AcceptEditRejectAction.java      | 3 +--
 .../state/actions/processingaction/FinalEditAction.java       | 3 +--
 .../state/actions/processingaction/ProcessingAction.java      | 1 +
 5 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/Action.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/Action.java
index 9da349073a..9cf202f12d 100644
--- a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/Action.java
+++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/Action.java
@@ -44,6 +44,10 @@ public abstract class Action {
     public abstract ActionResult execute(Context c, XmlWorkflowItem wfi, Step step, HttpServletRequest request)
         throws SQLException, AuthorizeException, IOException, WorkflowException;
 
+    /**
+     * Returns a list of options that the user can select at this action which results in the next step in the workflow
+     * @return  A list of options of this action, resulting in the next step of the workflow
+     */
     public abstract List<String> getOptions();
 
     public WorkflowActionConfig getParent() {
diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/WorkflowActionConfig.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/WorkflowActionConfig.java
index 26c14bfe11..1dc61888b1 100644
--- a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/WorkflowActionConfig.java
+++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/WorkflowActionConfig.java
@@ -61,6 +61,10 @@ public class WorkflowActionConfig {
         return step;
     }
 
+    /**
+     * Returns a list of options the user has on this action, resulting in the next step of the workflow
+     * @return  A list of options of this action, resulting in the next step of the workflow
+     */
     public List<String> getOptions() {
         return this.processingAction.getOptions();
     }
diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/AcceptEditRejectAction.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/AcceptEditRejectAction.java
index 56440e4d64..3c595b7545 100644
--- a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/AcceptEditRejectAction.java
+++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/AcceptEditRejectAction.java
@@ -35,7 +35,6 @@ public class AcceptEditRejectAction extends ProcessingAction {
 
     private static final String SUBMIT_APPROVE = "submit_approve";
     private static final String SUBMIT_REJECT = "submit_reject";
-    private static final String SUBMIT_EDIT_METADATA = "submit_edit_metadata";
 
     //TODO: rename to AcceptAndEditMetadataAction
 
@@ -63,7 +62,7 @@ public class AcceptEditRejectAction extends ProcessingAction {
         List<String> options = new ArrayList<>();
         options.add(SUBMIT_APPROVE);
         options.add(SUBMIT_REJECT);
-        options.add(SUBMIT_EDIT_METADATA);
+        options.add(ProcessingAction.SUBMIT_EDIT_METADATA);
         return options;
     }
 
diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/FinalEditAction.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/FinalEditAction.java
index 1f39815d63..fe73bf6a5d 100644
--- a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/FinalEditAction.java
+++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/FinalEditAction.java
@@ -33,7 +33,6 @@ import org.dspace.xmlworkflow.storedcomponents.XmlWorkflowItem;
 public class FinalEditAction extends ProcessingAction {
 
     private static final String SUBMIT_APPROVE = "submit_approve";
-    private static final String SUBMIT_EDIT_METADATA = "submit_edit_metadata";
 
     @Override
     public void activate(Context c, XmlWorkflowItem wf) {
@@ -63,7 +62,7 @@ public class FinalEditAction extends ProcessingAction {
     public List<String> getOptions() {
         List<String> options = new ArrayList<>();
         options.add(SUBMIT_APPROVE);
-        options.add(SUBMIT_EDIT_METADATA);
+        options.add(ProcessingAction.SUBMIT_EDIT_METADATA);
         return options;
     }
 
diff --git a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/ProcessingAction.java b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/ProcessingAction.java
index 1fbb02710d..98af6facf3 100644
--- a/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/ProcessingAction.java
+++ b/dspace-api/src/main/java/org/dspace/xmlworkflow/state/actions/processingaction/ProcessingAction.java
@@ -34,6 +34,7 @@ public abstract class ProcessingAction extends Action {
     @Autowired(required = true)
     protected ItemService itemService;
 
+    protected static final String SUBMIT_EDIT_METADATA = "submit_edit_metadata";
 
     @Override
     public boolean isAuthorized(Context context, HttpServletRequest request, XmlWorkflowItem wfi) throws SQLException {