X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2Fcommands%2Fsp%2FCategoriesCommand.java;h=e94ce2605c359756da75f76fed333391ea0bb49b;hb=86f289cd42ba95846c80d22129ed565e4e9d6dde;hp=bccd65c0a744f7e60ffff22674adfb85b961aa45;hpb=45780ca51a3f1a967acda7c4d7d71aebe7081a67;p=mkjsf-moved-to-github.git

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..e94ce26 100644
--- 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,21 @@ import com.indexdata.mkjsf.pazpar2.Pz2Service;
 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;
 import com.indexdata.mkjsf.pazpar2.data.sp.CategoriesResponse;
 
+/**
+ * Represents a Service Proxy <code>categories</code> command, can be accessed by <code>pzreq.sp.categories</code>
+ * 
+ * <p>Retrieves target categories available to the current Service Proxy user.</p> 
+ * <p>Target categories can be used to limit a search to resources tagged with the given 
+ * category. The following request in a Faces page would obtain categories for display in, say, a select list:
+ * <p>
+ *  <code>pzreq.sp.categories.run().targetCategories</code>   
+ * <p>
+ * This would get the Service Proxy extension commands, pick the categories command, execute it, and retrieve
+ *  a list of TargetCategory objects from the returned response data object.  
+ * </p>
+ * @author Niels Erik
+ *
+ */
 public class CategoriesCommand extends Pazpar2Command implements ServiceProxyCommand {
 
   private static final long serialVersionUID = 5023993689780291641L;