src/jalview/ws/api/MsaI.java

   1 package jalview.ws.api;
   2
   3 import jalview.datamodel.SequenceI;
   4 import jalview.ws.params.ArgumentI;
   5 import jalview.ws.params.WsParamSetI;
   6
   7 import java.util.List;
   8
   9 /**
  10  * MSA analysis interface
  11  *
  12  * @author jprocter
  13  *
  14  *         Generic job submission/management model: - A service instance
  15  *         implements one or more analysis interfaces, a status interface, a
  16  *         progress interface, and one or more results interface, plus any
  17  *         informational/descriptional interfaces - analysis interfaces return
  18  *         JobId or throw exceptions/errors.
  19  *
  20  *
  21  */
  22 public interface MsaI
  23 {
  24   /**
  25    * Given a set of sequences
  26    *
  27    * @param toalign
  28    * @param parameters
  29    * @param list
  30    * @return JobId or exceptions are thrown.
  31    * @throws Throwable
  32    */
  33   public JobId align(List<SequenceI> toalign, WsParamSetI parameters,
  34           List<ArgumentI> list)
  35           throws Throwable;
  36 }