Javadoc

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/ServiceProxyCommands.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/ServiceProxyCommands.java
index 8c4fefa..c874cc1 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/ServiceProxyCommands.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/sp/ServiceProxyCommands.java
@@ -7,6 +7,13 @@ import org.apache.log4j.Logger;
 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
 import com.indexdata.mkjsf.utils.Utils;\r
 \r
+/**\r
+ * ServiceProxyCommands holds references to all commands that are \r
+ * Service Proxy-only, those that are NOT supported by straight Pazpar2, that is.\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class ServiceProxyCommands implements Serializable {\r
 \r
   public static final String AUTH = "auth";\r
@@ -20,10 +27,20 @@ public class ServiceProxyCommands implements Serializable {
     this.stateMgr = stateMgr;\r
   }\r
   \r
+  /**\r
+   * auth command - referenced from UI as <code>pzreq.sp.auth</code>\r
+   * \r
+   * @return auth command from current state\r
+   */\r
   public AuthCommand getAuth() {\r
     return (AuthCommand) (stateMgr.getCommand(AUTH));\r
   }\r
   \r
+  /**\r
+   * categories command - referenced from UI as <code>pzreq.sp.categories</code>\r
+   * \r
+   * @return categories command from current state\r
+   */  \r
   public CategoriesCommand getCategories() {\r
     return (CategoriesCommand) (stateMgr.getCommand(CATEGORIES));\r
   }\r