src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java

   1 /**\r
   2  * \r
   3  * Each Pazpar2 command is represented by a class with methods for \r
   4  * setting parameters and running the command against \r
   5  * the selected Pazpar2 service. \r
   6  * <p>\r
   7  * The UI can access the command objects through the bean Pazpar2Commands, \r
   8  * which is exposed to the UI under the name <code>pzreq</code>.\r
   9  * </p>\r
  10  * <p>\r
  11  * For commands that has Service Proxy extension parameters, the UI \r
  12  * can access the extension parameters through the getSp() method\r
  13  * on the command - using for instance <code>pzreq.record.sp</code>\r
  14  * </p>\r
  15  * <p>\r
  16  * The UI can access Service Proxy-only commands through the getSp()\r
  17  * method on the pzreq bean - for instance <code>pzreq.sp.categories</code>\r
  18  * </p>\r
  19  * <p>Examples:</p>\r
  20  * <ul>\r
  21  *  <li><code>pzreq.search.query</code> references getter and setter for the \r
  22  *          query parameter of the search command.</li>\r
  23  * \r
  24  *  <li><code>pzreq.search.run()</code> executes the search command with current\r
  25  *          parameters</li>\r
  26  *                      \r
  27  *  <li><code>pzreq.record.sp.recordquery</code> references getter and setter on a Service Proxy-only \r
  28  *          <i>parameter</i> to the record command</li> \r
  29  *         \r
  30  *  <li><code>pzreq.sp.auth.run()</code> executes a Service Proxy-only <i>command</i></li> \r
  31  * </ul>          \r
  32  *          \r
  33  */\r
  34 package com.indexdata.mkjsf.pazpar2.commands;