org.dlese.dpc.dds
Class DDSStandardSearchResult

java.lang.Object
  org.dlese.dpc.dds.DDSStandardSearchResult

public final class DDSStandardSearchResult
extends Object

Structure that holds the results of a standard DDS text/field search. This Object is returned by DDSQueryAction.ddsStandardQuery(javax.servlet.http.HttpServletRequest, java.lang.String, org.dlese.dpc.repository.RepositoryManager, org.dlese.dpc.vocab.MetadataVocab, javax.servlet.ServletContext, int) and is used by DDSQueryAction and DDSServicesAction.

Author:

John Weatherley

See Also:

DDSQueryAction, DDSServicesAction

Constructor Summary

DDSStandardSearchResult()
Constructor for the DDSStandardSearchResult object

DDSStandardSearchResult(ResultDocList results, Exception exception, String forwardName)
Constructor for the DDSStandardSearchResult object

Method Summary

Exception	getException() Gets the Exception if one occured, or null if none.
String	getForwardName() Gets the name of the page to forward to, which is one of 'simple.query' or 'whats.new.query'.
ResultDocList	getResults() Gets the search results.

Methods inherited from class java.lang.Object

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

Constructor Detail

DDSStandardSearchResult

public DDSStandardSearchResult()

Constructor for the DDSStandardSearchResult object

DDSStandardSearchResult

public DDSStandardSearchResult(ResultDocList results,
                               Exception exception,
                               String forwardName)

Constructor for the DDSStandardSearchResult object

Parameters:

results - The search results.

forwardName - The name that describes which page to forward to to render the results.

exception - An Exception if one occured, or null

Method Detail

getResults

public ResultDocList getResults()

Gets the search results.

Returns:

The results value

getException

public Exception getException()

Gets the Exception if one occured, or null if none.

Returns:

An Exception or null

getForwardName

public String getForwardName()

Gets the name of the page to forward to, which is one of 'simple.query' or 'whats.new.query'.

Returns:

The forwardName value