Merge branch 'JAL-3878_ws-overhaul-3' into with_ws_overhaul-3
[jalview.git] / src / jalview / ws2 / actions / alignment / AlignmentProviderI.java
1 package jalview.ws2.actions.alignment;
2
3 import java.io.IOException;
4
5 import jalview.datamodel.AlignmentI;
6
7 import jalview.ws2.api.WebServiceJobHandle;
8 import jalview.ws2.client.api.AlignmentWebServiceClientI;
9 import jalview.ws2.client.api.WebServiceClientI;
10
11 /**
12  * An interface for providing alignment results to the alignment services. Web
13  * service clients that want to support alignment actions must implement this
14  * interface in addition to {@link WebServiceClientI}.
15  * 
16  * @author mmwarowny
17  *
18  * @see AlignmentWebServiceClientI
19  */
20 public interface AlignmentProviderI
21 {
22   /**
23    * Get the alignment result for the job from the server.
24    * 
25    * @param job
26    *          web service job
27    * @return alignment result
28    * @throws IOException
29    *           server communication error
30    */
31   public AlignmentI getAlignment(WebServiceJobHandle job) throws IOException;
32 }