package com.indexdata.pz2utils4jsf.pazpar2;\r
\r
import java.io.Serializable;\r
-import java.util.List;\r
\r
import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
-import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;\r
\r
public interface Pz2Interface extends Serializable {\r
\r
* \r
*/\r
public String update (String commands);\r
- \r
- \r
- public void setFilter(String filterExpression);\r
- \r
- public String getFilter();\r
-\r
- \r
- /**\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 setSingleTargetFilter (String targetId, String targetName);\r
- \r
- /**\r
- * Removes the current target filter from the search\r
- * \r
- */\r
- public void removeSingleTargetFilter ();\r
- \r
- /**\r
- * \r
- * @return The target filter set on the current search command\r
- */\r
- public SingleTargetFilter getSingleTargetFilter();\r
- \r
- /**\r
- * Resolves if the current search command has a target filter - to\r
- * be used by the UI for conditional rendering of target filter info.\r
- * \r
- * @return true if the current search command is limited by a target \r
- * filter\r
- */\r
- public boolean hasSingleTargetFilter();\r
- \r
+ \r
/**\r
* Will retrieve or remove the record with the given recid from memory.\r
* \r
* @return\r
*/\r
public String toggleRecord(String recid);\r
- \r
- /**\r
- * Returns the 'show' data as retrieved from pazpar2 by the most \r
- * recent update request\r
- * \r
- * @return pazpar2 'show' response object\r
- */\r
- public ShowResponse getShow();\r
- \r
- /**\r
- * Returns the 'stat' data as retrieved from pazpar2 by the most \r
- * recent update request\r
- * \r
- * @return pazpar2 'stat' response object\r
- */\r
- public StatResponse getStat();\r
- \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
- * Resolves whether the back-end has any records in memory (in 'show') for \r
- * display in UI\r
- * \r
- * @return true if there are records to display\r
- */\r
- public boolean hasRecords ();\r
- \r
- /**\r
- * Returns a pazpar2 record as retrieved by the most recent 'record'\r
- * request \r
- * @return record data object\r
- */\r
- public RecordResponse getRecord();\r
- \r
- /**\r
- * Returns a set of term lists (targets and facets) as retrieved by the \r
- * most recent 'termlist' command \r
- * @return set of termlists\r
- */\r
- public TermListsResponse getTermLists ();\r
- \r
- /**\r
- * Returns up to 'count' terms from the facet given by the 'facet' parameter\r
- * @param facet name of the facet\r
- * @param count maximum number of facet terms to return\r
- * @return facet term list limited to 'count' terms\r
- */\r
- public List<TermResponse> getFacetTerms (String facet, int count);\r
- \r
- /**\r
- * Returns all the terms of a given facet - or as many as pazpar2 returns\r
- * @param facet name of the facet\r
- * @return facet term list\r
- */\r
- public List<TermResponse> getFacetTerms (String facet);\r
- \r
- /**\r
- * Returns a ByTarget data object as retrieved by the most recent 'bytarget' \r
- * request to pazpar2\r
- * \r
- * @return ByTarget response data object\r
- */\r
- public ByTarget getByTarget();\r
+ \r
\r
/**\r
* Initiates a pager object, a component holding the data to draw a sequence\r
*/\r
public void setCurrentStateKey(String key);\r
\r
- /** \r
- * @return true if any errors encountered so far\r
- */\r
- public boolean hasErrors();\r
- \r
- /**\r
- * \r
- * @return true if errors encountered during execution of commands\r
- */\r
- public boolean hasCommandErrors();\r
- \r
- /**\r
- * \r
- * @return true if errors encountered when configuring the service\r
- */\r
- public boolean hasConfigurationErrors();\r
- \r
- /**\r
- * Returns one (of possibly multiple) errors encountered during execution of commands\r
- * Will prefer to show the search errors - if any - as the search command is usually \r
- * executed first. \r
- * \r
- * @return\r
- */\r
- public ErrorInterface getCommandError();\r
- \r
- /**\r
- * Returns all errors encountered during configuration of the application, in particular\r
- * the Pazpar2 client. \r
- * \r
- * @return\r
- */\r
- public List<ErrorInterface> getConfigurationErrors();\r
\r
\r
}\r
projects / mkjsf-moved-to-github.git / blobdiff