1 package jalview.ws2.actions.api;
5 import jalview.ws2.api.JobStatus;
6 import jalview.ws2.client.api.WebServiceJob;
9 * The listener interface for receiving relevant job progress and state change
10 * events on the task. The listener object is registered with the task on its
11 * creation in {@link ActionI#perform} method. An event is generated when the
12 * task is started, restarted, completed, fails with an exception or its global
13 * status changes. Additional, sub-job related, events are emitted when the
14 * sub-job status, log or error log changes.
20 public interface TaskEventListener<T>
23 * Invoked when the task has been started. The {@code subJobs} parameter
24 * contains a complete list of sub-jobs for that run. Note that restartable
25 * tasks may invoke this method multiple times with different set of
29 * task this event originates from
31 * list of sub-jobs for this run
33 void taskStarted(TaskI<T> source, List<WebServiceJob> subJobs);
36 * Invoked when the global task status has changed.
39 * task this event originates from
43 void taskStatusChanged(TaskI<T> source, JobStatus status);
46 * Invoked when the task has completed. If the task completed with a result,
47 * that result is passed in the call argument, otherwise, a {@code null}
51 * task this event originates from
53 * computation result or null if result not present
55 void taskCompleted(TaskI<T> source, T result);
58 * Invoked when an unhandled exception has occurred during task execution.
61 * task this event originates from
65 void taskException(TaskI<T> source, Exception e);
68 * Invoked when the task had been restarted. This event is only applicable
69 * to restartable tasks and will precede each {@link #taskStarted} after
73 * task this event originates from
75 void taskRestarted(TaskI<T> source);
78 * Invoked when the status of a sub-job has changed.
81 * task this event originates form
83 * sub-job that has been updated
87 void subJobStatusChanged(TaskI<T> source, WebServiceJob job, JobStatus status);
90 * Invoked when a log string of the sub-job has changed.
93 * task this event originates form
95 * sub-job that has been updated
99 void subJobLogChanged(TaskI<T> source, WebServiceJob job, String log);
102 * Invoked when an error log string of the sub-job has changed.
105 * task this event originates form
107 * sub-job that has been updated
111 void subJobErrorLogChanged(TaskI<T> source, WebServiceJob job, String log);