JAL-2446 merged to spike branch

[jalview.git] / src / jalview / fts / api / GFTSPanelI.java

diff --git a/src/jalview/fts/api/GFTSPanelI.java b/src/jalview/fts/api/GFTSPanelI.java
index 07ae5a1..99c0c51 100644 (file)
--- a/src/jalview/fts/api/GFTSPanelI.java
+++ b/src/jalview/fts/api/GFTSPanelI.java
@@ -21,6 +21,8 @@
 
 package jalview.fts.api;
 
+import java.util.Map;
+
 import javax.swing.JTable;
 
 /**
@@ -33,8 +35,12 @@ public interface GFTSPanelI
 
   /**
    * Action performed when a text is entered in the search field.
+   * 
+   * @param isFreshSearch
+   *          if true a fresh search is executed else a pagination search is
+   *          executed
    */
-  public void searchAction();
+  public void searchAction(boolean isFreshSearch);
 
   /**
    * Action performed when search results are selected and the 'ok' button is
@@ -93,9 +99,50 @@ public interface GFTSPanelI
    */
   public void setSearchInProgress(Boolean isSearchInProgress);
 
+  /**
+   * Action performed when previous page (<<) button is pressed pressed.
+   */
   public void prevPageAction();
 
+  /**
+   * Action performed when next page (>>) button is pressed pressed.
+   */
   public void nextPageAction();
 
+  /**
+   * Checks if the current service's search result is paginate-able
+   * 
+   * @return true means the service provides paginated results
+   */
   public boolean isPaginationEnabled();
+
+  /**
+   * Updates the 'enabled' state for the previous page button
+   * 
+   * @param isEnabled
+   */
+  public void setPrevPageButtonEnabled(boolean isEnabled);
+
+  /**
+   * Updates the 'enabled' state for the next page button
+   * 
+   * @param isEnabled
+   */
+  public void setNextPageButtonEnabled(boolean isEnabled);
+
+  /**
+   * The HashMap used to store user preferences for summary table columns,
+   * window size and position
+   * 
+   * @return
+   */
+  public Map<String, Integer> getTempUserPrefs();
+
+  /**
+   * Returns unique key used for storing an FTSs instance cache items in the
+   * cache data structure
+   * 
+   * @return
+   */
+  public String getCacheKey();
 }