com.mkdoc.query
Interface QueryContext

All Known Subinterfaces:
Query
All Known Implementing Classes:
AbstractQueryContext, RssQueryContext, SimpleQuery, TextQueryContext, XhtmlQueryContext

public interface QueryContext

An output context for a query

Version:
0.2 2005-08-04
Author:
Philip Shaw

Field Summary
static java.lang.String HTML
          The XHTML output type.
static int LIMIT
          The default number of results per page.
static java.lang.String RSS
          The RSS output type.
static java.lang.String TEXT
          The text output type.
 
Method Summary
 java.lang.String getOutputType()
          Get the requested output format for the result.
 int getPageNumber()
          Get the requested page number for any results.
 int getResultsPerPage()
          Get the maximum number of results to display per page.
 

Field Detail

LIMIT

public static final int LIMIT
The default number of results per page.

Since:
Version 0.2 2005-08-04
See Also:
Constant Field Values

TEXT

public static final java.lang.String TEXT
The text output type.

Since:
Version 0.1 2005-08-02
See Also:
Constant Field Values

HTML

public static final java.lang.String HTML
The XHTML output type.

Since:
Version 0.1 2005-08-02
See Also:
Constant Field Values

RSS

public static final java.lang.String RSS
The RSS output type.

Since:
Version 0.1 2005-08-02
See Also:
Constant Field Values
Method Detail

getPageNumber

public int getPageNumber()
Get the requested page number for any results.

Returns:
The page number for any results
Since:
Version 0.1 2005-08-02

getResultsPerPage

public int getResultsPerPage()
Get the maximum number of results to display per page.

Returns:
The maximum number of results to display per page.
Since:
Version 0.1 2005-08-02

getOutputType

public java.lang.String getOutputType()
Get the requested output format for the result.

Returns:
The output type for the result.
Since:
Version 0.1 2005-08-02