Update of /cvsroot/archive-access/archive-access/projects/wayback/src/java/org/archive/wayback
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6166/src/java/org/archive/wayback
Modified Files:
QueryRenderer.java
Log Message:
Comments
Index: QueryRenderer.java
===================================================================
RCS file: /cvsroot/archive-access/archive-access/projects/wayback/src/java/org/archive/wayback/QueryRenderer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** QueryRenderer.java 16 Nov 2005 03:11:29 -0000 1.1
--- QueryRenderer.java 1 Dec 2005 01:48:22 -0000 1.2
***************
*** 43,55 ****
public interface QueryRenderer extends PropertyConfigurable {
public void renderException(HttpServletRequest httpRequest,
HttpServletResponse httpResponse, WaybackRequest wbRequest,
WaybackException exception) throws ServletException, IOException;
public void renderUrlResults(HttpServletRequest httpRequest,
! HttpServletResponse response, WaybackRequest wbRequest,
SearchResults results, ReplayResultURIConverter uriConverter)
throws ServletException, IOException;
public void renderUrlPrefixResults(HttpServletRequest httpRequest,
HttpServletResponse response, WaybackRequest wbRequest,
--- 43,88 ----
public interface QueryRenderer extends PropertyConfigurable {
+ /** Show an output page indicating that a request to the Wayback Machine
+ * failed for some reason, as determined by the WaybackException argument.
+ *
+ * @param httpRequest the HttpServletRequest
+ * @param httpResponse the HttpServletResponse
+ * @param wbRequest the WaybackRequest that caused the exception
+ * @param exception the WaybackException thrown while handling
+ * @throws ServletException
+ * @throws IOException
+ */
public void renderException(HttpServletRequest httpRequest,
HttpServletResponse httpResponse, WaybackRequest wbRequest,
WaybackException exception) throws ServletException, IOException;
+ /** Show the SearchResults of the request for this particular URL
+ *
+ * @param httpRequest the HttpServletRequest
+ * @param httpResponse the HttpServletResponse
+ * @param wbRequest the WaybackRequest that returned the results
+ * @param results the SearchResults that the WaybackRequest matched
+ * @param uriConverter the URI converter to use to translate matching
+ * results into replayable URLs
+ * @throws ServletException
+ * @throws IOException
+ */
public void renderUrlResults(HttpServletRequest httpRequest,
! HttpServletResponse httpResponse, WaybackRequest wbRequest,
SearchResults results, ReplayResultURIConverter uriConverter)
throws ServletException, IOException;
+ /** Show the SearchResults of the request which may have resulted in
+ * multiple matching URLs.
+ *
+ * @param httpRequest the HttpServletRequest
+ * @param response the HttpServletResponse
+ * @param wbRequest the WaybackRequest that returned the results
+ * @param results the SearchResults that the WaybackRequest matched
+ * @param uriConverter the URI converter to use to translate matching
+ * results into replayable URLs
+ * @throws ServletException
+ * @throws IOException
+ */
public void renderUrlPrefixResults(HttpServletRequest httpRequest,
HttpServletResponse response, WaybackRequest wbRequest,
|