Adds filter attribute, renames target id filter attribute

[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
index ef820da..8a59cfe 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Interface.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Interface.java
@@ -97,26 +97,36 @@ public interface Pz2Interface extends Serializable {
    */\r
   public void setFacetOnQuery(String facetKey, String term);\r
   \r
+  \r
+  public void setFilter(String filterExpression);\r
+  \r
+  public String getFilter();\r
+\r
+  \r
   /**\r
-   * Adds a target filter to limit the current query by, then\r
-   * executes the current search.\r
+   * Adds a single target filter to restrict the current query by, \r
+   * then executes the current search.\r
+   * \r
+   * This is a special case of the general setFilter function, \r
+   * allowing to associate a descriptive target name with the \r
+   * filter expression for display in UI. \r
    * \r
    * @param targetId pazpar2's ID for the target to limit by\r
    * @param targetName a descriptive name for the target\r
    */\r
-  public void setTargetFilter (String targetId, String targetName);\r
+  public void setSingleTargetFilter (String targetId, String targetName);\r
   \r
   /**\r
    * Removes the current target filter from the search\r
    * \r
    */\r
-  public void removeTargetFilter ();\r
+  public void removeSingleTargetFilter ();\r
   \r
   /**\r
    * \r
    * @return The target filter set on the current search command\r
    */\r
-  public TargetFilter getTargetFilter();\r
+  public SingleTargetFilter getSingleTargetFilter();\r
   \r
   /**\r
    * Resolves if the current search command has a target filter - to\r
@@ -125,8 +135,8 @@ public interface Pz2Interface extends Serializable {
    * @return true if the current search command is limited by a target \r
    * filter\r
    */\r
-  public boolean hasTargetFilter();\r
-  \r
+  public boolean hasSingleTargetFilter();\r
+    \r
   /**\r
    * Sets the ordering of records (hits) in the 'show' display object\r
    */\r