Merge branch 'master' of ssh://git.indexdata.com/home/git/private/mkjsf.git into...

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / commands / package-info.java

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java
new file mode 100644 (file)
index 0000000..4fae890
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java
@@ -0,0 +1,34 @@
+/**\r
+ * \r
+ * Each Pazpar2 command is represented by a class with methods for \r
+ * setting parameters and running the command against \r
+ * the selected Pazpar2 service. \r
+ * <p>\r
+ * The UI can access the command objects through the bean Pazpar2Commands, \r
+ * which is exposed to the UI under the name <code>pzreq</code>.\r
+ * </p>\r
+ * <p>\r
+ * For commands that has Service Proxy extension parameters, the UI \r
+ * can access the extension parameters through the getSp() method\r
+ * on the command - using for instance <code>pzreq.record.sp</code>\r
+ * </p>\r
+ * <p>\r
+ * The UI can access Service Proxy-only commands through the getSp()\r
+ * method on the pzreq bean - for instance <code>pzreq.sp.categories</code>\r
+ * </p>\r
+ * <p>Examples:</p>\r
+ * <ul>\r
+ *  <li><code>pzreq.search.query</code> references getter and setter for the \r
+ *          query parameter of the search command.</li>\r
+ * \r
+ *  <li><code>pzreq.search.run()</code> executes the search command with current\r
+ *          parameters</li>\r
+ *                      \r
+ *  <li><code>pzreq.record.sp.recordquery</code> references getter and setter on a Service Proxy-only \r
+ *          <i>parameter</i> to the record command</li> \r
+ *         \r
+ *  <li><code>pzreq.sp.auth.run()</code> executes a Service Proxy-only <i>command</i></li> \r
+ * </ul>          \r
+ *          \r
+ */\r
+package com.indexdata.mkjsf.pazpar2.commands;
\ No newline at end of file