Javadoc
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / data / sp / SpResponses.java
1 package com.indexdata.mkjsf.pazpar2.data.sp;\r
2 \r
3 import java.io.Serializable;\r
4 \r
5 import com.indexdata.mkjsf.pazpar2.data.Responses;\r
6 \r
7 /**\r
8  * Provides references to all current Service Proxy-only data objects.\r
9  *  \r
10  * @author Niels Erik\r
11  *\r
12  */\r
13 public class SpResponses implements Serializable {\r
14   \r
15   private static final long serialVersionUID = -3831357590639961167L;\r
16   private Responses responses = null;  \r
17 \r
18   public SpResponses(Responses responses) {\r
19     this.responses = responses;  \r
20   }\r
21   \r
22   /**\r
23    * Resets all responses from the search request to any request \r
24    * that can follow search (i.e. show and bytarget but not init or auth) \r
25    * @param includePazpar2Responses Set to true if the invocation should\r
26    *                                reset Pazpar2 responses \r
27    *                                (non-SP-specific responses) as well. \r
28    */\r
29   public void resetSearchAndBeyond(boolean includePazpar2Responses) {\r
30     if (includePazpar2Responses) {\r
31       responses.resetSearchAndBeyond();\r
32     }\r
33   }\r
34 \r
35   /**\r
36    * Resets all responses from the init request to any request \r
37    * that can follow init (i.e. search and show but not auth) \r
38    * @param includePazpar2Responses Set to true if the invocation should\r
39    *                                reset Pazpar2 responses \r
40    *                                (non-SP-specific responses) as well. \r
41    */\r
42   public void resetInitAndBeyond (boolean includePazpar2Responses) {\r
43     responses.put("categories", new CategoriesResponse());\r
44     if (includePazpar2Responses) {\r
45       responses.resetInitAndBeyond();\r
46     }\r
47     resetSearchAndBeyond(includePazpar2Responses);    \r
48   }\r
49   \r
50   /**\r
51    * Resets all responses from the authentication request to any request \r
52    * that can follow authentication. \r
53    * @param includePazpar2Responses Set to true if the invocation should\r
54    *                                reset Pazpar2 responses \r
55    *                                (non-SP-specific responses) as well. \r
56    */\r
57   public void resetAuthAndBeyond (boolean includePazpar2Responses) {\r
58     responses.put("auth", new AuthResponse());\r
59     resetInitAndBeyond(includePazpar2Responses);    \r
60   }\r
61 \r
62   \r
63   public AuthResponse getAuth () {\r
64     return ((AuthResponse) responses.getResponseObject("auth"));\r
65   }\r
66 \r
67   public CategoriesResponse getCategories() {\r
68     return ((CategoriesResponse) responses.getResponseObject("categories"));\r
69   }\r
70 \r
71 }\r