com.primus.ae.searchclient
Interface ClientRequest

All Superinterfaces:

atg.search.routing.command.SearchEngineRequest

All Known Implementing Classes:

ClientCategorizeRequest, ClientCategoryRequest, ClientQueryRequest, ClientRequestImpl, ClientSimilarDocsRequest, ClientStructuredRequest, ClientVicRequest

public interface ClientRequest
extends atg.search.routing.command.SearchEngineRequest

Client request interface

Field Summary

static int	BROWSE
static int	CATEGORIZE
static int	INSPECT
static int	QUERY this is the simplest way to maintain backward compatibility.
static java.lang.String	REQUEST_TAG_BROWSE Deprecated. as of 2007.0
static java.lang.String	REQUEST_TAG_CATEGORIZE Deprecated. as of 2007.0
static java.lang.String	REQUEST_TAG_QUERY Deprecated. as of 2007.0
static java.lang.String	REQUEST_TAG_SIMILARDOCS Deprecated. as of 2007.0
static java.lang.String	REQUEST_TAG_STRUCTQUERY Deprecated. as of 2007.0
static java.lang.String	REQUEST_TAG_VIC Deprecated. as of 2007.0
static int	SIMILARDOCS
static int	STRUCTQUERY
static java.lang.String[]	TAGS
static int	VIC

Fields inherited from interface atg.search.routing.command.SearchEngineRequest

CLASS_VERSION

Method Summary

DocumentSetConstraint	getConstraints() Returns the constraints object, which might be null.
ParserOptions	getParsingOptions()
int	getRequestId()
java.lang.String	getRequestIdentifier()
long	getRequestTime() The time of day that the request occured, in milliseconds since 1970.
boolean	isListPropertyAllowed() Returns false by default.
boolean	isLoggingEnabled() Indicates whether DB logging is enabled or disabled
void	setConstraints(DocumentSetConstraint constraints) Sets the document set constraints for the query
void	setListPropertyAllowed(boolean listPropertiesAllowed) Enables storage of multi-valued properties in the Result's properties HashMap.
void	setLoggingEnabled(boolean loggingEnabled) Enables or disables DB logging
void	setParsingOptions(ParserOptions parsingOptions)
void	setRequestIdentifier(java.lang.String pId)
void	setRequestTime(long pRequestTime) Sets the time of request in milliseconds (as in the time of day).

Methods inherited from interface atg.search.routing.command.SearchEngineRequest

getRequestAttribute, getRequestAttributes, getRequestTag, isFiringSearchEvents, isKeepingResponseData, isLoggingThisRequest, processResponse, setFiringSearchEvents, setKeepingResponseData, setLoggingThisRequest, setRequestAttribute, setRequestAttributes, toXML

Field Detail

QUERY

static final int QUERY

this is the simplest way to maintain backward compatibility. Each constant is the index in the TAGS array for the corresponding command tag.

See Also:

Constant Field Values

BROWSE

static final int BROWSE

See Also:

Constant Field Values

STRUCTQUERY

static final int STRUCTQUERY

See Also:

Constant Field Values

VIC

static final int VIC

See Also:

Constant Field Values

SIMILARDOCS

static final int SIMILARDOCS

See Also:

Constant Field Values

CATEGORIZE

static final int CATEGORIZE

See Also:

Constant Field Values

INSPECT

static final int INSPECT

See Also:

Constant Field Values

TAGS

static final java.lang.String[] TAGS

REQUEST_TAG_QUERY

static final java.lang.String REQUEST_TAG_QUERY

Deprecated. as of 2007.0

request tag (in xml) for the query request

See Also:

Constant Field Values

REQUEST_TAG_BROWSE

static final java.lang.String REQUEST_TAG_BROWSE

Deprecated. as of 2007.0

request tag (in xml) for the category browse request

See Also:

Constant Field Values

REQUEST_TAG_STRUCTQUERY

static final java.lang.String REQUEST_TAG_STRUCTQUERY

Deprecated. as of 2007.0

request tag (in xml) for the structured query request

See Also:

Constant Field Values

REQUEST_TAG_VIC

static final java.lang.String REQUEST_TAG_VIC

Deprecated. as of 2007.0

request tag (in xml) for the view in context request

See Also:

Constant Field Values

REQUEST_TAG_SIMILARDOCS

static final java.lang.String REQUEST_TAG_SIMILARDOCS

Deprecated. as of 2007.0

request tag (in xml) for the similar docs request

See Also:

Constant Field Values

REQUEST_TAG_CATEGORIZE

static final java.lang.String REQUEST_TAG_CATEGORIZE

Deprecated. as of 2007.0

request tag (in xml) for the similar docs request

See Also:

Constant Field Values

Method Detail

getRequestIdentifier

java.lang.String getRequestIdentifier()

Returns:

a unique identifier for the request

setRequestIdentifier

void setRequestIdentifier(java.lang.String pId)

Parameters:

pId - unique request identifier

getRequestId

int getRequestId()

Returns:

one of the request constants defined by this class

getConstraints

DocumentSetConstraint getConstraints()

Returns the constraints object, which might be null.

Returns:

constraints

setConstraints

void setConstraints(DocumentSetConstraint constraints)

Sets the document set constraints for the query

Parameters:

constraints - constraints

isListPropertyAllowed

boolean isListPropertyAllowed()

Returns false by default. If true, expect Lists from the Result's properties HashMap. Otherwise expect Strings.

Returns:

setListPropertyAllowed

void setListPropertyAllowed(boolean listPropertiesAllowed)

Enables storage of multi-valued properties in the Result's properties HashMap. All values will be Lists, whether or not they are multi-valued. Default is false.

Parameters:

listPropertiesAllowed - true to enable list properties

isLoggingEnabled

boolean isLoggingEnabled()

Indicates whether DB logging is enabled or disabled

Returns:

true if logging is enabled

setLoggingEnabled

void setLoggingEnabled(boolean loggingEnabled)

Enables or disables DB logging

Parameters:

loggingEnabled - true if logging is enabled

getParsingOptions

ParserOptions getParsingOptions()

Returns:

parsing options

setParsingOptions

void setParsingOptions(ParserOptions parsingOptions)

Parameters:

parsingOptions - parsing options

setRequestTime

void setRequestTime(long pRequestTime)

Sets the time of request in milliseconds (as in the time of day). Set automatically.

Parameters:

pRequestTime - current time in milliseconds

getRequestTime

long getRequestTime()

The time of day that the request occured, in milliseconds since 1970.

Returns:

time of request in milliseconds