Javadoc

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/CategoriesCommand.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/CategoriesCommand.java
index bccd65c..b3794ec 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/CategoriesCommand.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/CategoriesCommand.java
@@ -6,6 +6,20 @@ import com.indexdata.mkjsf.pazpar2.Pz2Service;
 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\r
 import com.indexdata.mkjsf.pazpar2.data.sp.CategoriesResponse;\r
 \r
+/**\r
+ * Retrieves target categories available to the current Service Proxy user.\r
+ * <p>\r
+ * Target categories can be used to limit a search to resources tagged with the given \r
+ * category. The following request in a Faces page would obtain categories for displaying, say, a select list:\r
+ * <p>\r
+ *  pzreq.sp.categories.run().targetCategories   \r
+ * <p>\r
+ * This would get the Service Proxy extension commands, pick the categories command, execute it, and retrieve\r
+ *  a list of TargetCategory objects from the returned response data object.  \r
+ * </p>\r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class CategoriesCommand extends Pazpar2Command implements ServiceProxyCommand {\r
 \r
   private static final long serialVersionUID = 5023993689780291641L;\r