JAL-2071 architectural improvement for Plugable Free Text Search Services
[jalview.git] / src / jalview / fts / api / FTSRestClientI.java
1 package jalview.fts.api;
2
3 import jalview.fts.core.FTSRestRequest;
4 import jalview.fts.core.FTSRestResponse;
5
6 import java.util.Collection;
7
8 public interface FTSRestClientI
9 {
10
11   public FTSRestResponse executeRequest(FTSRestRequest pdbRestRequest)
12           throws Exception;
13
14   public String getColumnDataConfigFile();
15
16   public FTSDataColumnGroupI getDataColumnGroupById(String id)
17           throws Exception;
18
19   public FTSDataColumnI getDataColumnByNameOrCode(String nameOrCode)
20           throws Exception;
21
22   public int getPrimaryKeyColumIndex(
23           Collection<FTSDataColumnI> wantedFields, boolean hasRefSeq)
24           throws Exception;
25           
26   public FTSDataColumnI getPrimaryKeyColumn();
27
28   public Collection<FTSDataColumnI> getAllDefaulDisplayedDataColumns();
29
30   public Collection<FTSDataColumnI> getSearchableDataColumns();
31
32   public Collection<FTSDataColumnI> getAllFTSDataColumns();
33 }
34