oracle.webcenter.search

Interface QueryHandler<T>

All Known Subinterfaces:

QueryExecutor<T>, QueryFederator<T>

public interface QueryHandler<T>

This interface determines how a query gets executed. Implementations of it get created from the QueryHandlerFactory. Callers may create one QueryHandler per request to make sure that there are no threading issues. This allows for client code to prepare for receiving the results from executing this query. The QueryContext can imply structure in the results that may help UI clients lay out its forms to better render the results.

Since:

11.1.1.0.0 Beta 2

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	QUERY_CLASS_NAME The Caller identifier
static java.lang.String	SERVICE_ID The Service identifier (not the extension ID)
static java.lang.String	TITLE The title to show the results with TODO: This has become obsoleted
static java.lang.String	TITLE_ARG The prefix of an argument of the title resource An int suffix representing the n-th argument should be appended, e.g.
static java.lang.String	TITLE_ARGS_COUNT The arguments count of the title resource
static java.lang.String	TITLE_RESOURCE_BUNDLE The resource bundle for looking up the title resource key
static java.lang.String	TITLE_RESOURCE_KEY The title resource key for getting the resource string to show the results with

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns a map of query handler properties that allow for UI to be more easily built.

Field Detail

TITLE

static final java.lang.String TITLE

The title to show the results with TODO: This has become obsoleted

See Also:

Constant Field Values

TITLE_RESOURCE_KEY

static final java.lang.String TITLE_RESOURCE_KEY

The title resource key for getting the resource string to show the results with

See Also:

Constant Field Values

TITLE_RESOURCE_BUNDLE

static final java.lang.String TITLE_RESOURCE_BUNDLE

The resource bundle for looking up the title resource key

See Also:

Constant Field Values

TITLE_ARGS_COUNT

static final java.lang.String TITLE_ARGS_COUNT

The arguments count of the title resource

See Also:

Constant Field Values

TITLE_ARG

static final java.lang.String TITLE_ARG

The prefix of an argument of the title resource An int suffix representing the n-th argument should be appended, e.g. TITLE_ARG1

See Also:

Constant Field Values

SERVICE_ID

static final java.lang.String SERVICE_ID

The Service identifier (not the extension ID)

See Also:

Constant Field Values

QUERY_CLASS_NAME

static final java.lang.String QUERY_CLASS_NAME

The Caller identifier

See Also:

Constant Field Values

Method Detail

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns a map of query handler properties that allow for UI to be more easily built.

Returns:

a Map of String keys and String values.