This topic defines the QueryFunction classes included in the Discovery Framework.
Function Class | ENEQuery Equivalent | Configuration Properties | Notes |
---|---|---|---|
EQLFilter |
setNavRecord¬ StructureExpr() |
eqlFilter: String |
Applying an EQL filter always overwrites previous EQLFilters . |
NegativeRefinement¬ Filter |
setNavRecordFilter() |
dimValName: String dimValId: String dimensionName: String dimensionId: String ancestors: String[] |
|
RangeFilter |
setNavRangeFilters() |
property: String rangeOperator: (LT|LTEQ|GT|GTEQ¬ |BTWN|GCLT|GCGT|GCBTWN) value1: numeric value2: numeric (optional) value3: numeric (optional) |
Only available in IAP 6. |
RecordAggregator |
setNavRollupKey() |
rollupKey: String aggCount: ({{ONE_EREC_PER_AGGR| ALL_ERECS_PER_AGGR| ZERO_ERECS_PER_AGGR)}} |
Only available in IAP 6. |
RecordFilter |
setNavRecordFilter() |
recordFilter: String |
|
RecordSpecListFilter |
setERecs() |
recSpecs: String[] |
Only available in IAP 6. Applying a RecordSpecListFilter always overwrites previous RecordSpecListFilters. |
RefinementFilter |
setNavDescriptors() |
dimValId: long dimensionId: long multiSelect: (AND|OR|NONE) (optional) navigable: (true|false) (optional) |
|
SearchFilter |
setNavERecSearches() |
searchInterface: String terms: String matchMode: (ALL|PARTIAL|ANY| ALLANY|ALLPARTIAL| PARTIALMAX|BOOLEAN) |
Function Class | ENEQuery Equivalent | Configuration Properties | Notes |
---|---|---|---|
AnalyticsQueryConfig |
setAnalyticsQuery() |
analyticsQuery: String |
|
BreadcrumbsConfig |
N/A |
returnFullPath: boolean (optional) |
MDEX 7 Discovery Service only. Has no effect in IAP 6. |
DimensionSearch¬ Config |
|
searchTerm: String maxPerDimension: int (optional) dimensionId: String (optional) dimValId: String (optional) matchMode: (ALL|PARTIAL|ANY| ALLANY|ALLPARTIAL| PARTIALMAX|BOOLEAN) relevanceRanking¬ Strategy: String (optional) |
|
ExposeRefinement |
setNavExposed¬ Refinements() |
dimValId: String dimensionId: String ownerId: String (optional) dimExposed: boolean (optional) exposeAll: boolean (optional) maxRefinements: int (optional) |
At least one of dimValId or dimensionId is required. ownerId can be the ID of a NavConfig instance. dimExposed indicates whether the dimension is exposed. exposeAll indicates whether the dimension is fully exposed (that is, the "More..." link is selected). maxRefinements is only valid in the MDEX 7 Discovery Service. It has no effect in IAP 6. The default value is 100. |
NavConfig |
setNavAllRefinements |
exposeAllRefinements: boolean |
|
ResultsConfig |
setNavNumERecs() setNavERecsOffset() setSelection |
recordsPerPage: int offset: int (optional) columns: String[] (optional) numBulkRecords: int (optional) |
|
ResultsSummaryConfig |
N/A |
||
SearchKeysConfig |
N/A |
MDEX 7 Discovery Service only. Has no effect in IAP 6. | |
SortConfig |
setNavActiveSortKeys() |
property: String ascending: boolean |