Javadoc

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/InitCommand.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/InitCommand.java
index d52ec51..e98a5cf 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/InitCommand.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/InitCommand.java
@@ -5,6 +5,12 @@ import org.apache.log4j.Logger;
 import com.indexdata.mkjsf.pazpar2.commands.sp.InitCommandSp;\r
 import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;\r
 \r
+/**\r
+ * Represents a Pazpar2 <code>init</code> command.\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class InitCommand extends Pazpar2Command implements ServiceProxyCommand {\r
 \r
   private static final long serialVersionUID = -4915976465898889987L;\r
@@ -15,27 +21,48 @@ public class InitCommand extends Pazpar2Command implements ServiceProxyCommand {
     super("init");\r
   }\r
   \r
+  /**\r
+   * Sets the <code>clear</code> parameter. See Pazpar2 documentation for details.\r
+   * \r
+   * @param clear\r
+   */\r
   public void setClear(String clear) { \r
     setParameterInState(new CommandParameter("clear","=",clear));\r
   }\r
-  \r
+\r
+  /**\r
+   * Returns the <code>clear</code> parameter value.\r
+   */\r
   public String getClear() {\r
     return getParameterValue("clear");\r
   }\r
   \r
+  /**\r
+   * Sets the <code>service</code> parameter. See Pazpar2 documentation for details.\r
+   * @param serviceId\r
+   */\r
   public void setService(String serviceId) {    \r
     setParameterInState(new CommandParameter("service","=",serviceId));\r
   }\r
   \r
+  /**\r
+   * Returns the <code>service</code> parameter value.\r
+   */  \r
   public String getService() {\r
     return getParameterValue("service");\r
   }\r
   \r
+  /**\r
+   * Disabled, not supported for <code>init</code>\r
+   */\r
   @Override\r
   public void setSession (String sessionId) {\r
     throw new UnsupportedOperationException("Cannot set session id on init command");\r
   }\r
-  \r
+\r
+  /**\r
+   * Disabled, not supported for <code>init</code>\r
+   */\r
   @Override\r
   public String getSession () {\r
     throw new UnsupportedOperationException("Cannot set or get session id on init command");\r