Renames class, removes obsolete, javadoc

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/RecordCommand.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/RecordCommand.java
index d453b75..8cc039d 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/RecordCommand.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/RecordCommand.java
@@ -12,7 +12,7 @@ import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;
 import com.indexdata.mkjsf.pazpar2.data.ResponseParser;\r
 \r
 /**\r
- * Represents a Pazpar2 <code>record</code> command. \r
+ * Represents a Pazpar2 <code>record</code> command, can be accessed by <code>pzreq.record</code>\r
  * \r
  * @author Niels Erik\r
  *\r
@@ -27,6 +27,14 @@ public class RecordCommand extends Pazpar2Command implements ServiceProxyCommand
     super("record");\r
   }\r
   \r
+  /**\r
+   * Special handling of record responses since they come in three distinctly different ways\r
+   * <ol>\r
+   *  <li>As a regular &lt;record&gt; document</li>\r
+   *  <li>In arbitrary XML format, in case of an offset request to get the native format</li>\r
+   *  <li>In binary (non XML) format</li>\r
+   * </ol> \r
+   */\r
   @Override\r
   public ResponseDataObject run() {\r
     ResponseDataObject responseObject = null;\r