com.esri.gpt.control.csw.inbound202
Class RetrievalOptions

java.lang.Object
  com.esri.gpt.control.csw.inbound202.RetrievalOptions

public class RetrievalOptions
extends Object

Defines the basic retrieval options associated with a query.

By default the options is instantiated with:

a new ElementSet

startRecord = 1

maxRecords = 10

resultType = ResultType.results

outputFormat = null

outputSchema = null

Field Summary

static int

THRESHOLD_MAXRECORDS The threshold for the maximum number of record to return = 5000

Constructor Summary

RetrievalOptions()
Deprecated. use RetrievalOptions(RequestContext)

RetrievalOptions(RequestContext requestContext)
Constructs with an associated request context.

Method Summary

void	echo(StringBuffer sb) Appends property information for the component to a StringBuffer.
String	getBaseContextPath() Gets the base context path associated with an active HTTP request.
String	getBaseURL() Gets the base URL used for call back functions.
ElementSet	getElementSet() Gets the response element set.
int	getMaxRecords() Gets the maximum number of records to return.
String	getOutputFormat() Gets the media type of the response message.
String	getOutputSchema() Gets the preferred schema for records in the result set.
String	getRequestId() Gets the client supplied request id.
ResultType	getResultType() Gets the result type.
int	getStartRecord() Gets the starting record.
void	setBaseURL(String baseURL) Sets the base URL used for call back functions.
void	setElementSetType(ElementSet elementSet) Sets the response element set.
void	setMaxRecords(int maxRecords) Sets the maximum number of records to return.
void	setOutputFormat(String outputFormat) Sets the media type of the response message.
void	setOutputSchema(String outputSchema) Sets the preferred schema for records in the result set.
void	setRequestId(String id) Sets the client supplied request id.
void	setResultType(ResultType resultType) Sets the result type.
void	setStartRecord(int startRecord) Sets the starting record.

Methods inherited from class java.lang.Object

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

Field Detail

THRESHOLD_MAXRECORDS

public static final int THRESHOLD_MAXRECORDS

The threshold for the maximum number of record to return = 5000

See Also:

Constant Field Values

Constructor Detail

RetrievalOptions

public RetrievalOptions()

Deprecated. use RetrievalOptions(RequestContext)

Default constructor.

RetrievalOptions

public RetrievalOptions(RequestContext requestContext)

Constructs with an associated request context.

Parameters:

requestContext - the request context

Method Detail

getBaseContextPath

public String getBaseContextPath()

Gets the base context path associated with an active HTTP request.

Returns:

base context path (http://<host:port>/<Context>), or an empty string)

getBaseURL

public String getBaseURL()

Gets the base URL used for call back functions.

Returns:

the base URL

setBaseURL

public void setBaseURL(String baseURL)

Sets the base URL used for call back functions.

Parameters:

baseURL - the base URL

getElementSet

public ElementSet getElementSet()

Gets the response element set.

Returns:

the element set

setElementSetType

public void setElementSetType(ElementSet elementSet)

Sets the response element set.

Parameters:

elementSet - the element set

getMaxRecords

public int getMaxRecords()

Gets the maximum number of records to return.

Returns:

the maximum number of records to return

setMaxRecords

public void setMaxRecords(int maxRecords)

Sets the maximum number of records to return.
A value of zero or less will return no records (hit count only).
If the supplied value exceeds the threshold, the max records will be set to the threshold.

Parameters:

maxRecords - maximum number of records to return

getOutputSchema

public String getOutputSchema()

Gets the preferred schema for records in the result set.

Returns:

the preferred output schema

setOutputSchema

public void setOutputSchema(String outputSchema)

Sets the preferred schema for records in the result set.

Parameters:

outputSchema - the preferred output schema

getOutputFormat

public String getOutputFormat()

Gets the media type of the response message.

Returns:

the media type of the response

setOutputFormat

public void setOutputFormat(String outputFormat)

Sets the media type of the response message.

Parameters:

outputFormat - media type of the response

getRequestId

public String getRequestId()

Gets the client supplied request id.

Returns:

the client supplied request id

setRequestId

public void setRequestId(String id)

Sets the client supplied request id.

Parameters:

id - the client supplied request id

getResultType

public ResultType getResultType()

Gets the result type.

Returns:

the result type

setResultType

public void setResultType(ResultType resultType)

Sets the result type.

Parameters:

resultType - the result type

getStartRecord

public int getStartRecord()

Gets the starting record.

Returns:

the starting record

setStartRecord

public void setStartRecord(int startRecord)

Sets the starting record.
If the supplied value is less that 1, the start record will be set to 1.

Parameters:

startRecord - the starting record

echo

public void echo(StringBuffer sb)

Appends property information for the component to a StringBuffer.
The method is intended to support "FINEST" logging.

Parameters:

sb - the StringBuffer to use when appending information