Renames class, removes obsolete, javadoc

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/Responses.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/Responses.java
index 1397023..90e7f8d 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/data/Responses.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/Responses.java
@@ -20,6 +20,12 @@ import com.indexdata.mkjsf.pazpar2.data.sp.SpResponseDataObject;
 import com.indexdata.mkjsf.pazpar2.data.sp.SpResponses;\r
 import com.indexdata.mkjsf.utils.Utils;\r
 \r
+/**\r
+ * Provides references to all current data objects and has general methods for clearing certain response data.\r
+ *  \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 @SessionScoped @Named\r
 public class Responses implements Serializable {\r
     \r
@@ -81,17 +87,25 @@ public class Responses implements Serializable {
     return error;         \r
   }\r
   \r
+  /**\r
+   * Empties all data objects populated after a search (including the search response itself)\r
+   * \r
+   */\r
   public void resetSearchAndBeyond() {\r
     logger.debug("Resetting show,stat,termlist,bytarget,record,search response objects.");\r
     dataObjects.put("show", new ShowResponse());\r
     dataObjects.put("stat", new StatResponse());\r
     dataObjects.put("termlist", new TermListsResponse());\r
-    dataObjects.put("bytarget", new ByTarget());\r
+    dataObjects.put("bytarget", new ByTargetResponse());\r
     dataObjects.put("record", new RecordResponse());\r
     dataObjects.put("search", new SearchResponse());\r
     getSp().resetSearchAndBeyond(false);\r
   }\r
   \r
+  /**\r
+   * Empties all data objects populated after a service was initialized, including the init response itself\r
+   * but excluding a possible auth response\r
+   */\r
   public void resetInitAndBeyond () {\r
     dataObjects.put("init", new InitResponse());        \r
     resetSearchAndBeyond();\r
@@ -130,8 +144,8 @@ public class Responses implements Serializable {
     return (getTermLists().getTermList(facet).getTerms());\r
   }\r
   \r
-  public ByTarget getByTarget() {\r
-    return ((ByTarget) dataObjects.get("bytarget"));\r
+  public ByTargetResponse getByTarget() {\r
+    return ((ByTargetResponse) dataObjects.get("bytarget"));\r
   }\r
 \r
   public ResponseDataObject getResponseObject (String name) {\r