public interface IDfQueryDefinition extends IDfSearchSourceContainer
IDfQueryProcessor
. Use IDfSearchService
to initialize the IDfQueryProcessor with the IDfQueryDefinition.Modifier and Type | Field and Description |
---|---|
static int |
QUERY_DEF_TYPE_BUILDER
Query type: Query Builder.
|
static int |
QUERY_DEF_TYPE_PASSTHROUGH
Query type: Pass-through.
|
static int |
QUERY_DEF_TYPE_UNDEFINED
Internal query type used to identify uninitialized query.
|
Modifier and Type | Method and Description |
---|---|
IDfQueryDefinition |
copy()
Performs a deep copy of the query definition.
|
int |
getMaxResultCount()
Gets the global maximum result count to be expected from processing the query, for all search sources.
|
int |
getMaxResultPerSource()
Gets the maximum result count to be expected from one search source.
|
IDfSearchMetadataManager |
getMetadataMgr()
Provides access to an instance of the
IDfSearchMetadataManager of the query. |
int |
getQueryDefinitionType()
Get the Query definition type.
|
boolean |
isQueryBuilder()
Tests the
QUERY_DEF_TYPE_BUILDER type. |
void |
setMaxResultCount(int maxResultCount)
Sets the global maximum result count to be expected from processing the query, for all search sources.
|
void |
setMaxResultPerSource(int maxResultCount)
Sets the maximum result count to be expected from one search source.
|
addSelectedSource, clearSelectedSources, getSelectedSourceCount, getSelectedSources, removeSelectedSource
static final int QUERY_DEF_TYPE_UNDEFINED
static final int QUERY_DEF_TYPE_BUILDER
IDfQueryBuilder
interface.static final int QUERY_DEF_TYPE_PASSTHROUGH
IDfPassThroughQuery
interface.int getQueryDefinitionType()
boolean isQueryBuilder()
QUERY_DEF_TYPE_BUILDER
type. It is useful because this type is a
primary type of the Query definition.true
, if query type is QUERY_DEF_TYPE_BUILDER
.int getMaxResultCount()
setMaxResPerSource()
.void setMaxResultCount(int maxResultCount)
setMaxResPerSource()
.maxResultCount
- The global maximum result count defined for this query definition; or -1 if the maximum is
not defined in this query definition (in this case the maximum is the one defined by the
configuration file).int getMaxResultPerSource()
setMaxResultCount()
, the maximum defined by the administrator in the configuration file, and finally
this maximum result count per source.void setMaxResultPerSource(int maxResultCount)
setMaxResultCount()
, the maximum defined by the administrator in the configuration file, and finally
this maximum result count per source.maxResultCount
- The maximum result count defined for each source; or -1 if there is no maximum.IDfSearchMetadataManager getMetadataMgr()
IDfSearchMetadataManager
of the query. This instance is owned by
the query definition; changing its state will impact the query. For example, using the IDfSearchSourceContainer.addSelectedSource(String)
method for this instance will adjust selected sources for the
query definition as well.IDfSearchMetadataManager
.IDfQueryDefinition copy()
Copyright 1994-2023 OpenText Corporation. All rights reserved.