Merge branch 'mmw/JAL-4199-web-services-testing' into mmw/bug/JAL-4241-annotation...

[jalview.git] / src / jalview / ws2 / actions / api / ActionI.java

diff --git a/src/jalview/ws2/actions/api/ActionI.java b/src/jalview/ws2/actions/api/ActionI.java
index c789b32..e84fd58 100644 (file)
--- a/src/jalview/ws2/actions/api/ActionI.java
+++ b/src/jalview/ws2/actions/api/ActionI.java
@@ -3,10 +3,14 @@ package jalview.ws2.actions.api;
 import java.util.EnumSet;
 import java.util.List;
 
+import javax.swing.Icon;
+
+import jalview.api.AlignViewportI;
 import jalview.viewmodel.AlignmentViewport;
 import jalview.ws.params.ArgumentI;
 import jalview.ws2.api.CredentialType;
 import jalview.ws2.api.Credentials;
+import jalview.ws2.api.WebService;
 
 /**
  * {@code Action} object represents an executable action that the web service
@@ -21,12 +25,19 @@ import jalview.ws2.api.Credentials;
  * 
  * @author mmwarowny
  *
- * @param <T>
+ * @param <R>
  *          task result type
  */
-public interface ActionI<T>
+public interface ActionI<R>
 {
   /**
+   * Get the web service containing this action.
+   * 
+   * @return containing web service
+   */
+  WebService<? extends ActionI<R>> getWebService();
+
+  /**
    * Get the name of the action. Typically, it should be the same as the name of
    * the service.
    * 
@@ -35,12 +46,27 @@ public interface ActionI<T>
   String getName();
 
   /**
+   * Get the full name of the action consisting of the service name and the
+   * action name if present.
+   * 
+   * @return full name of this action
+   */
+  default String getFullName()
+  {
+    var name = getName();
+    if (name == null || name.isEmpty())
+      return getWebService().getName();
+    else
+      return getWebService().getName() + " " + name;
+  }
+
+  /**
    * Get the tooltip for the action which contains extra details about the
    * action.
    * 
    * @return action tooltip
    */
-  String getToolip();
+  String getTooltip();
 
   /**
    * Get the subcategory this action belongs to. Can be used to group or
@@ -90,10 +116,8 @@ public interface ActionI<T>
   EnumSet<CredentialType> getRequiredCredentials();
 
   /**
-   * Run the action, create and start a new task with provided viewport,
-   * arguments and credentials and attach the handler to the task. The
-   * implementations of this method are responsible for starting the task using
-   * execution method appropriate for the action class.
+   * Create a new task with provided viewport, arguments and credentials ready
+   * to be started.
    * 
    * @param viewport
    *          current alignment viewport
@@ -101,12 +125,10 @@ public interface ActionI<T>
    *          job parameters appropriate for the service
    * @param credentials
    *          optional user credentials
-   * @param handler
-   *          event handler attached to the new task
-   * @return new running task
+   * @return new task
    */
-  TaskI<T> perform(AlignmentViewport viewport, List<ArgumentI> args,
-      Credentials credentials, TaskEventListener<T> handler);
+  TaskI<R> createTask(AlignViewportI viewport, List<ArgumentI> args,
+      Credentials credentials);
 
   /**
    * Return if the action is currently active for the given viewport. Active