From 126fb8a77d8b741e1365e3d13dd06098ebf3ab72 Mon Sep 17 00:00:00 2001 From: Mateusz Warowny Date: Fri, 18 Feb 2022 17:29:52 +0100 Subject: [PATCH] JAL-3878 Provide javadoc for WebServiceClientI interface --- src/jalview/ws2/client/api/WebServiceClientI.java | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/jalview/ws2/client/api/WebServiceClientI.java b/src/jalview/ws2/client/api/WebServiceClientI.java index f788442..e62909e 100644 --- a/src/jalview/ws2/client/api/WebServiceClientI.java +++ b/src/jalview/ws2/client/api/WebServiceClientI.java @@ -8,6 +8,17 @@ import jalview.ws.params.ArgumentI; import jalview.ws2.api.Credentials; import jalview.ws2.api.WebServiceJob; +/** + * A common interface for all web service clients that provide methods to + * get the URL of the server the client is talking to, submit new jobs to the + * server as well as poll or cancel the running jobs. This interface does not + * provide means to retrieve job results as those may differ between + * web services. Specialized sub-interfaces define methods to retrieve job + * results appropriate for specific service types. + * + * @author mmwarowny + * + */ public interface WebServiceClientI { /** -- 1.7.10.2