package com.indexdata.mkjsf.pazpar2.commands;\r
\r
import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;\r
+import com.indexdata.mkjsf.pazpar2.commands.sp.ShowCommandSp;\r
\r
+\r
+/**\r
+ * <b><code>show</code></b> Pazpar2 command, referenced as: <code>pzreq.show</code> \r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
public class ShowCommand extends Pazpar2Command implements ServiceProxyCommand {\r
\r
private static final long serialVersionUID = -8242768313266051307L;\r
}\r
\r
/**\r
- * Sets the sort order for results, the updates the 'show' data object\r
- * from pazpar2. Set valid sort options in the documentation for pazpar2.\r
- * \r
- * The parts of the UI that display 'show' data should be rendered following\r
- * this request.\r
- * \r
- * @param sortOption\r
+ * Sets Pazpar2 parameter <code>sort</code>. See Pazpar2 documentation for details. \r
*/\r
public void setSort (String sort) {\r
setParameter(new CommandParameter("sort","=",sort));\r
}\r
\r
/**\r
- * Retrieves the current sort order for results\r
- * @return sort order - i.e. 'relevance'\r
+ * Gets parameter value for <code>sort</cod>\r
*/\r
public String getSort () {\r
return getParameter("sort") != null ? getParameter("sort").value : "relevance";\r
}\r
\r
/**\r
- * Sets the first record to show - starting at record '0'. After setting\r
- * first record number, the 'show' data object will be updated from pazpar2,\r
- * and the parts of the UI displaying show data should be re-rendered.\r
- * \r
- * To be used by the UI for paging.\r
- * \r
- * @param start first record to show\r
+ * Sets Pazpar2 parameter <code>start</code>. See Pazpar2 documentation for details. \r
*/\r
public void setStart (int start) { \r
setParameter(new CommandParameter("start","=",start)); \r
return getParameter("start") != null ? Integer.parseInt(getParameter("start").value) : 0;\r
}\r
\r
+ /**\r
+ * Sets Pazpar2 parameter <code>num</code>. See Pazpar2 documentation for details. \r
+ */\r
public void setNum (int num) {\r
setParameter(new CommandParameter("num","=",num));\r
}\r
- \r
+ \r
+ /** \r
+ * Get the parameter value for <code>num</code>\r
+ */\r
public int getNum () {\r
return getParameter("num") != null ? Integer.parseInt(getParameter("num").value) : 0;\r
}\r
\r
+ /**\r
+ * Sets Pazpar2 parameter <code>block</code>. See Pazpar2 documentation for details. \r
+ */\r
public void setBlock(String block) {\r
setParameterInState(new CommandParameter("block","=",block));\r
}\r
- \r
+\r
+ /** \r
+ * Get the parameter value for <code>block</code>\r
+ */\r
public String getBlock() {\r
return getParameterValue("block");\r
}\r
\r
+ /**\r
+ * Sets Pazpar2 parameter <code>mergekey</code>. See Pazpar2 documentation for details. \r
+ */\r
public void setMergekey (String mergekey) {\r
setParameter(new CommandParameter("mergekey","=",mergekey));\r
}\r
\r
+ /** \r
+ * Get the parameter value for <code>mergekey</code>\r
+ */\r
public String getMergekey () {\r
return getParameterValue("mergekey");\r
}\r
\r
+ /**\r
+ * Sets Pazpar2 parameter <code>rank</code>. See Pazpar2 documentation for details. \r
+ */\r
public void setRank (String rank) {\r
setParameter(new CommandParameter("rank","=",rank));\r
}\r
\r
+ /** \r
+ * Get the parameter value for <code>rank</code>\r
+ */\r
public String getRank () {\r
return getParameterValue("rank");\r
}\r
\r
@Override\r
public ServiceProxyCommand getSp() {\r
- return this;\r
+ return new ShowCommandSp(this);\r
}\r
\r
@Override\r