com.sage.orion.sdata.servlet
Class OpenSearchResult

java.lang.Object
  com.sage.orion.sdata.servlet.OpenSearchResult

public class OpenSearchResult
extends java.lang.Object

An OpenSearch information block

Field Summary

static java.lang.String	ITEMS_PER_PAGE_TAG The tag used for the items per page entry
static java.lang.String	NAMESPACE_PREFIX The namespace prefix to use, until we can get namespaces working properly
static java.lang.String	START_INDEX_TAG The tag used for the start index entry
static java.lang.String	TOTAL_RESULTS_TAG The tag used for the total results entry
static java.lang.String	URI The URI of the OpenSearch specification

Constructor Summary

OpenSearchResult()
constructs an empty instance of the openSearchResult

OpenSearchResult(int pageSize, int totalRecords, int startIndex)
constructs an instance of the OpenSearchResult class for the given data

Method Summary

void	addToDOM(org.w3c.dom.Element parent) adds the content of this instance to the given DOM element

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ITEMS_PER_PAGE_TAG

public static final java.lang.String ITEMS_PER_PAGE_TAG

The tag used for the items per page entry

See Also:

Constant Field Values

NAMESPACE_PREFIX

public static final java.lang.String NAMESPACE_PREFIX

The namespace prefix to use, until we can get namespaces working properly

See Also:

Constant Field Values

START_INDEX_TAG

public static final java.lang.String START_INDEX_TAG

The tag used for the start index entry

See Also:

Constant Field Values

TOTAL_RESULTS_TAG

public static final java.lang.String TOTAL_RESULTS_TAG

The tag used for the total results entry

See Also:

Constant Field Values

URI

public static final java.lang.String URI

The URI of the OpenSearch specification

See Also:

Constant Field Values

Constructor Detail

OpenSearchResult

public OpenSearchResult(int pageSize,
                        int totalRecords,
                        int startIndex)

constructs an instance of the OpenSearchResult class for the given data

Parameters:

pageSize - the size of a normal page

totalRecords - the total number of records

startIndex - the 1-based index of the first record in the corresponding results

OpenSearchResult

public OpenSearchResult()

constructs an empty instance of the openSearchResult

Method Detail

addToDOM

public void addToDOM(org.w3c.dom.Element parent)

adds the content of this instance to the given DOM element

Parameters:

parent -