Renames pz2utils4jsf package to mkjsf

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / pazpar2 / Pz2Interface.java

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Interface.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Interface.java
deleted file mode 100644 (file)
index f0cd6d4..0000000
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Interface.java
+++ /dev/null
@@ -1,101 +0,0 @@
-package com.indexdata.pz2utils4jsf.pazpar2;\r
-\r
-import java.io.Serializable;\r
-\r
-import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
-\r
-public interface Pz2Interface extends Serializable {\r
-\r
-  /**\r
-   * Executes a Pazpar2 search using the given query string\r
-   * \r
-   * @param query\r
-   */\r
-  public void doSearch(String query);\r
-  \r
-  /**\r
-   * Executes a Pazpar2 search using the current query \r
-   */\r
-  public void doSearch();\r
-  \r
-  /**\r
-   * Updates display data objects by issuing the following pazpar2 commands: \r
-   * 'show', 'stat', 'termlist' and 'bytarget'.\r
-   *  \r
-   * Returns a count of the remaining active clients from the most recent search.\r
-   * \r
-   * After refreshing the data from pazpar2 the UI components displaying those \r
-   * data should be re-rendered.\r
-   * \r
-   * @return count of activeclients \r
-   */\r
-  public String update();\r
-  \r
-  /**\r
-   * Updates the data objects given by a comma separated list of one or more commands - \r
-   * i.e. "show,state,termlist,bytarget".\r
-   *  \r
-   * May not be useful for the UI directly. \r
-   *  \r
-   * @param commands Command separated list of pazpar2 commands.\r
-   * @return count of activeclients \r
-   * \r
-   */\r
-  public String update (String commands);\r
-            \r
-  /**\r
-   * Will retrieve or remove the record with the given recid from memory.\r
-   * \r
-   * A pazpar2 'record' command will then be issued. The part of the UI \r
-   * showing record data should thus be re-rendered.\r
-   *  \r
-   * @param recid\r
-   * @return\r
-   */\r
-  public String toggleRecord(String recid);\r
-      \r
-  /**\r
-   * Resolves whether the backend has a record with the given recid in memory \r
-   * \r
-   * @return true if the bean currently holds the record with recid\r
-   */  \r
-  public boolean hasRecord (String recId);\r
-          \r
-    \r
-  /**\r
-   * Initiates a pager object, a component holding the data to draw a sequence\r
-   * of page numbers to navigate by and mechanisms to navigate with\r
-   * \r
-   * @param pageRange number of pages to display in the pager\r
-   * @return ResultsPager the initiated pager component\r
-   */\r
-  public ResultsPager setPager(int pageRange);\r
-  \r
-  /**\r
-   * Gives a component for drawing a pager to navigate by.\r
-   * @return ResultsPager pager component\r
-   */\r
-  public ResultsPager getPager();\r
-  \r
-  /**\r
-   * Returns the current hash key used, as used for internal session state tracking\r
-   * and potentially for browser history entries as well\r
-   * \r
-   * A UI author would not normally be concerned with retrieving this. It's used by the\r
-   * framework internally\r
-   *  \r
-   * @return string that can be used for browsers window.location.hash\r
-   */\r
-  public String getCurrentStateKey ();\r
-      \r
-  /**\r
-   * Sets the current state key, i.e. when user clicks back or forward in browser history.\r
-   * Would normally be automatically handled by the frameworks components.\r
-   *  \r
-   * @param key corresponding to browsers hash string\r
-   */\r
-  public void setCurrentStateKey(String key);\r
-  \r
-\r
-     \r
-}\r