The UrlENEQuery type exposes the following members.
Constructors
Name | Description | |
---|---|---|
UrlENEQuery()()()() |
No argument constructor.
| |
UrlENEQuery(String) | Obsolete.
Obsolete. Use the constructor that takes an encoding instead.
| |
UrlENEQuery(String, String) |
Constructor where the queryString gets parsed
into the individual query fields.
|
Methods
Name | Description | |
---|---|---|
AddSelection |
Adds the field named fieldName to the set of fields that should
be returned for each record in the result set.
(Inherited from ENEQuery.) | |
ContainsAggrERecQuery |
Returns if this query includes a aggregated record query.
(Inherited from ENEQuery.) | |
ContainsDimSearchQuery |
Returns if this query includes a dimension search query.
(Inherited from ENEQuery.) | |
ContainsERecQuery |
Returns if this query includes a record query.
(Inherited from ENEQuery.) | |
ContainsERecsQuery |
Returns if this query includes a query for records.
(Inherited from ENEQuery.) | |
ContainsNavQuery |
Returns whether the query includes a navigation query.
(Inherited from ENEQuery.) | |
ContainsQuery |
Returns whether the query is querying for any of a navigation,
record, dimension search, or a value set search.
(Inherited from ENEQuery.) | |
Equals | (Inherited from Object.) | |
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetNavActiveSortKeys |
Get the list of sort keys with which the navigation query's
records will be sorted.
(Inherited from ENEQuery.) | |
GetNavSortKey | Obsolete.
Gets the sort key with which the navigation query's records will be sorted.
(Inherited from ENEQuery.) | |
GetNavSortOrder | Obsolete.
Gets the sort order with which the navigation query's records
will be sorted.
(Inherited from ENEQuery.) | |
GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
SetA |
Sets the aggregated record for the query.
AggrERec.
| |
SetAf |
Sets the aggregated record navigation range filters.
AggrERecNavRangeFilters.
| |
SetAn |
Sets the aggregated record navigation values for the query.
AggrERecNavDescriptors.
| |
SetAr |
Sets the aggregated record navigation record filter.
AggrERecNavRecordFilter.
| |
SetArs |
Sets the aggregated record structure expression.
AggrERecStructureExpr.
| |
SetAs |
Sets the sort key for the record list of the aggregated record query.
| |
SetAu |
Sets the aggregated record rollup key with which the aggregated
record is derived. AggrERecRollupKey.
| |
SetD |
Sets the string dimension search query terms.
DimSearchTerms.
| |
SetDf |
Sets the dimension search navigation range filters.
DimSearchNavRangeFilters.
| |
SetDi |
Sets the dimension(s) with which to dimension search in.
DimSearchDimensions.
| |
SetDk |
Sets the dimension search behavior to order results.
DimSearchRankResults.
| |
SetDn |
Sets the navigation restriction for the dimension search.
DimSearchNavDescriptors | |
SetDo |
Sets the dimension search results offset.
DimSearchResultsOffset.
| |
SetDp | Obsolete.
Sets the number of results to return per dimension.
DimSearchNumDimValues | |
SetDr |
Sets the dimension search navigation record filter.
DimSearchNavRangeFilters.
| |
SetDrc |
Sets the list of refinement configs for the dimension search query.
refinement configs are delimited by '|'.
| |
SetDrs |
Sets the dimension search navigation structure expression.
DimSearchNavRecordStructureExpr.
| |
SetDu |
Sets the rollup key for the dimension search query.
DimSearchRollupKey.
| |
SetDx |
Sets the dimension search options.
DimSearchOpts.
| |
SetN |
Sets the navigation field of the query.
NavDescriptors | |
SetNa |
Sets an analytics query.
AnalyticsQuery | |
SetNao |
Sets the navigation aggregated record list offset.
NavAggrERecsOffset | |
SetNavActiveSortKeys |
Set the list of sort keys with which the navigation query's
records will be sorted.
(Inherited from ENEQuery.) | |
SetNavSortKey | Obsolete.
Sets the sort key with which the navigation query's records will be sorted.
(Inherited from ENEQuery.) | |
SetNavSortOrder | Obsolete.
Sets the sort order with which the navigation query's records will be sorted.
(Inherited from ENEQuery.) | |
SetNdr |
Sets the Disabled Refinements config for the navigation query.
| |
SetNe |
Sets the exposed navigation refinements.
NavExposedRefinements | |
SetNf |
Sets the range filters for the navigation query.
NavRangeFilters.
| |
SetNk |
Sets the key properties request for the navigation query.
NavKeyProperties | |
SetNmpt | ||
SetNmrf | ||
SetNo |
Sets the navigation record list offset.
NavERecsOffset | |
SetNp |
Sets the number of records per aggregated record.
NavERecsPerAggrERec | |
SetNr |
Sets the record filter for the navigation query.
NavRecordFilter.
| |
SetNrc |
Sets the list of dynamic refinement configs for the navigation query.
Dynamic refinement configs are delimited by '|'.
| |
SetNrcs |
Sets the list of stratified dim vals used by this navigation query.
Stratified dim vals are delimited by ';' and are in the form
[strata],[dimvalid].
| |
SetNrk |
Sets the key of the record search of the navigation query
using a specified relevance ranking strategy.
| |
SetNrm |
Sets the relevance ranking match mode for the record search of the navigation query.
| |
SetNrr |
Sets the relevance ranking strategy for the record search of the navigation query.
| |
SetNrs |
Sets the structure expression for the navigation query.
NavRecordStructureExpr.
| |
SetNrt |
Sets the terms of the record search of the navigation query using
a specified relevance ranking strategy.
| |
SetNs |
Sets the sort key for the record list of the navigation.
| |
SetNso |
Sets the sort order for the record list of the navigation.
| |
SetNtk |
Sets the keys of the record search of the navigation query.
| |
SetNtpc |
Sets whether the compute-autophrase record search functionality is on in
the query. NavERecSearchComputeAlternativePhrasings | |
SetNtpr |
Sets whether the rewrite-autophrase record search functionality is on in
the query. NavERecSearchRewriteQueryWithAnAlternativePhrasing | |
SetNtt |
Sets the terms of the record search of the navigation query.
| |
SetNtx |
Sets the options for the record search of the navigation query.
| |
SetNty |
Sets whether the did you mean record search functionality is on in
the query. NavERecSearchDidYouMean | |
SetNu |
Sets the rollup key for the navigation query.
NavRollupKey | |
SetNx |
Sets the navigation query options.
NavOpts.
| |
SetR |
Sets the records for query. ERecs.
| |
ToQueryString |
Takes a ENEQuery and serializes the object into
URL query string format.
| |
ToString()()()() |
Returns a string representation of this query.
| |
ToString(String) |
Returns a string representation of this query, using the given
character encoding.
|
Fields
Name | Description | |
---|---|---|
AGGR_EREC_NAV_DESCRIPTORS_PARAM |
Parameter name for aggregated record descriptors.
| |
AGGR_EREC_NAV_RANGE_FILTERS_PARAM |
Parameter name for aggregated record navigation range filters.
| |
AGGR_EREC_NAV_RECORD_FILTER_PARAM |
Parameter name for aggregated record navigation record filter.
| |
AGGR_EREC_PARAM |
Parameter name for aggregated records.
| |
AGGR_EREC_ROLLUP_KEY_PARAM |
Parameter name for aggregated record rollup keys.
| |
AGGR_EREC_SORT_KEY_PARAM |
Parameter name for aggregated record sort keys.
| |
AGGR_EREC_STRUCTURE_EXPR_PARAM |
Parameter name for aggregated record structure expression.
| |
ANALYTICS_PARAM |
Parameter name for Analytics query
| |
DIM_SEARCH_DIMENSIONS_PARAM |
Parameter name for dimension search dimension.
| |
DIM_SEARCH_NAV_DESCRIPTORS_PARAM |
Parameter name for dimension search navigation descriptors.
| |
DIM_SEARCH_NAV_RANGE_FILTERS_PARAM |
Parameter name for dimension search navigation range filters.
| |
DIM_SEARCH_NAV_RECORD_FILTER_PARAM |
Parameter name for dimension search navigation record filter.
| |
DIM_SEARCH_NAV_RECORD_STRUCTURE_EXPR_PARAM |
Parameter name for dimension search navigation structure expression.
| |
DIM_SEARCH_NUM_DIM_VALUES_PARAM |
Parameter name for number of dimension values to return.
| |
DIM_SEARCH_OPTS_PARAM |
Parameter name for dimension search options.
| |
DIM_SEARCH_RANK_RESULTS_PARAM |
Parameter name for ranking dimension search results.
| |
DIM_SEARCH_REFINEMENT_CONFIGS_PARAM |
Parameter name for dimension search refinement configs.
| |
DIM_SEARCH_RESULTS_OFFSET_PARAM |
Parameter name for dimension search results offset.
| |
DIM_SEARCH_ROLLUP_KEY_PARAM |
Parameter name for dimension search rollup key.
| |
DIM_SEARCH_TERMS_PARAM |
Parameter name for dimension search terms.
| |
ERECS_PARAM |
Parameter name for records.
| |
NAV_AGGR_ERECS_OFFSET_PARAM |
Parameter name for navigation aggregated record list offset.
| |
NAV_DESCRIPTORS_PARAM |
Parameter name for navigation values.
| |
NAV_DISABLED_REFINEMENTS_CONFIGS_PARAM |
Parameter name for disabled refinements config.
| |
NAV_EREC_SEARCH_COMPUTE_ALTERNATIVE_PHRASINGS_PARAM | Parameter name for navigation record search compute-autophrase.
| |
NAV_EREC_SEARCH_DID_YOU_MEAN_PARAM | Parameter name for navigation record search did you mean.
| |
NAV_EREC_SEARCH_KEYS_PARAM |
Parameter name for navigation record search keys.
| |
NAV_EREC_SEARCH_OPTS_PARAM |
Parameter name for navigation record search option sets.
| |
NAV_EREC_SEARCH_REWRITE_WITH_AN_ALTERNATIVE_PHRASING_PARAM | Parameter name for navigation record search rewrite-autophrase.
| |
NAV_EREC_SEARCH_TERMS_PARAM |
Parameter name for navigation record search term sets.
| |
NAV_ERECS_OFFSET_PARAM |
Parameter name for navigation record list offset.
| |
NAV_ERECS_PER_AGGR_EREC_PARAM |
Parameter name for navigation number of records per aggregated record.
| |
NAV_KEY_PROPERTIES_PARAM |
Parameter name for navigation key properties.
| |
NAV_MERCH_PREVIEW_TIME_PARAM |
Parameter name for navigation preview time.
| |
NAV_MERCH_RULE_FILTER_PARAM |
ParameterName for Merch rule filter
| |
NAV_OPTS_PARAM |
Parameter name for navigation query options (other than
options for record search, which are handled by Ntx).
| |
NAV_RANGE_FILTERS_PARAM | Parameter name for navigation range filters.
| |
NAV_RECORD_FILTER_PARAM |
Parameter name for navigation record filters.
| |
NAV_RECORD_STRUCTURE_EXPR_PARAM |
Parameter name for navigation structure expressions.
| |
NAV_REFINEMENT_CONFIGS_PARAM |
Parameter name for navigation refinement configs.
| |
NAV_RELRANK_EREC_RANK_KEY_PARAM |
Parameter name for navigation relevance ranking record search key.
| |
NAV_RELRANK_EREC_RANK_MATCH_PARAM |
Parameter name for navigation relevance ranking match mode
| |
NAV_RELRANK_EREC_RANK_STRATEGY_PARAM |
Parameter name for navigation relevance ranking record search strategy
| |
NAV_RELRANK_EREC_RANK_TERMS_PARAM |
Parameter name for navigation relevance ranking record search terms.
| |
NAV_RELRANK_EREC_SEARCH_KEY_PARAM |
Parameter name for navigation relevance ranking record search key.
| |
NAV_RELRANK_EREC_SEARCH_STRATEGY_PARAM |
Parameter name for navigation relevance ranking record search strategy
| |
NAV_RELRANK_EREC_SEARCH_TERMS_PARAM |
Parameter name for navigation relevance ranking record search terms.
| |
NAV_ROLLUP_KEY_PARAM |
Parameter name for navigation rollup key.
| |
NAV_SORT_KEY_PARAM |
Parameter name for navigation sort key.
| |
NAV_SORT_ORDER_PARAM |
Parameter name for navigation sort order.
| |
NAV_SPECIFIC_REFINEMENTS_PARAM |
Parameter name for navigation exposed refinements.
| |
NAV_STRATIFIED_DIM_VALS_PARAM |
Parameter name for navigation stratified dim vals.
| |
QUERY_ID_PARAM |
Parameter name for Request Id
| |
SESSION_ID_PARAM |
Parameter name for Session Id
|
Properties
Name | Description | |
---|---|---|
AggrERec | Obsolete.
Gets or sets the Id of the aggregated record to be queried for.
(Inherited from ENEQuery.) | |
AggrERecActiveSortKeys |
Get the list of sort keys with which the aggregated records
representative records will be sorted.
(Inherited from ENEQuery.) | |
AggrERecNavDescriptors |
Gets or sets the navigation values which the aggregated record will
be composed in relation to.
(Inherited from ENEQuery.) | |
AggrERecNavRangeFilters |
Gets or sets the navigation range filters which the aggregated record
will be composed in relation to.
(Inherited from ENEQuery.) | |
AggrERecNavRecordFilter |
Gets or sets the record filter which the aggregated record will be
composed in relation to.
(Inherited from ENEQuery.) | |
AggrERecRollupKey |
Gets or sets the rollup key the aggregated record is composed by.
(Inherited from ENEQuery.) | |
AggrERecSpec |
Gets or sets the specification of the aggregated record to be queried for.
(Inherited from ENEQuery.) | |
AggrERecStructureExpr |
Gets or sets the structure expression used to filter members of
the aggregated record.
(Inherited from ENEQuery.) | |
AnalyticsQuery |
Gets and sets the AnalyticsQuery instance that represents the
Analytics query that will be sent to the MDEX Engine. On set, if the query is
malformed, it will not be set on the HttpENEConnection and a SyntaxException
is thrown. An AnalyticsQuery instance can be built
programmatically or by calling the parseQuery(String) method.
(Inherited from ENEQuery.) | |
DimSearchCompound |
Gets and sets whether dimension search will include compound results.
(Inherited from ENEQuery.) | |
DimSearchDimension |
Gets and sets the dimension which which the dimension search can
search from.
(Inherited from ENEQuery.) | |
DimSearchDimensions |
Gets and sets the dimensions which which the dimension search can
search from.
(Inherited from ENEQuery.) | |
DimSearchNavDescriptors |
Gets and sets the navigation values that describe a navigation state
that restrict the number of values that can be searched from.
(Inherited from ENEQuery.) | |
DimSearchNavRangeFilters |
Gets and sets the navigation range filters that restrict the
dimension search.
(Inherited from ENEQuery.) | |
DimSearchNavRecordFilter |
Gets and sets the record filter that will restrict the dimension
search results.
(Inherited from ENEQuery.) | |
DimSearchNavRecordStructureExpr |
Gets and sets the structure expression that will restrict the dimension
search results.
(Inherited from ENEQuery.) | |
DimSearchNumDimValues | Obsolete.
Gets and sets the number of values returned from each dimension
for value search.
(Inherited from ENEQuery.) | |
DimSearchOpts |
Gets and sets the option set that dimension search will use.
(Inherited from ENEQuery.) | |
DimSearchRankResults |
Gets and sets how the dimension search will order its results.
(Inherited from ENEQuery.) | |
DimSearchRefinementConfigs |
Gets and sets the list of refinement configs to be used by the MDEX Engine for dimension search
(Inherited from ENEQuery.) | |
DimSearchResultsOffset |
Gets and sets the offset with which the dimension search will begin returning
results per dimension.
(Inherited from ENEQuery.) | |
DimSearchRollupKey |
Gets and sets the rollup key which the records of the dimension search query
should use to create aggregated counts. By setting a rollupKey with this
method, aggregated counts are returned as the value for the (Inherited from ENEQuery.)CopyC# Dgraph.AggrBins CopyC# DimVal CopyC# PropertyMap | |
DimSearchTerms |
Gets and sets the search terms the dimension search will use.
(Inherited from ENEQuery.) | |
ERec |
Sets the Id of the record to be queried for.
(Inherited from ENEQuery.) | |
ERecs |
Gets or sets the Ids of the records to be queried for.
(Inherited from ENEQuery.) | |
LanguageId |
Gets and sets the ISO639 language code to be used for this query.
The language id is sent to the MDEX Engine when the query is
executed, and specifies the language of any text portion of the
query. For example: search terms.
(Inherited from ENEQuery.) | |
NavAggrERecsOffset |
Gets and sets the offset into the navigation aggregated record list for
navigation query.
(Inherited from ENEQuery.) | |
NavAllRefinements |
Gets and sets the query such that the navigation query will return with all
the refinements possible for all dimensions.
(Inherited from ENEQuery.) | |
NavDescriptors |
Gets and sets the navigation descriptor IDs describing the navigation object
to be queried for.
(Inherited from ENEQuery.) | |
NavDisabledRefinementsConfig |
Gets and sets the disabled refinements config.
(Inherited from ENEQuery.) | |
NavERecSearchComputeAlternativePhrasings |
Gets and sets if the fulltext search should turn on the compute-autophrase feature.
(Inherited from ENEQuery.) | |
NavERecSearchDidYouMean |
Gets and sets if the fulltext search should turn on the did you mean feature.
(Inherited from ENEQuery.) | |
NavERecSearches |
Gets and sets the navigation record searches to perform on the records
of the navigation query.
(Inherited from ENEQuery.) | |
NavERecSearchRewriteQueryWithAnAlternativePhrasing |
Gets and sets if the fulltext search should turn on the rewrite-autophrase feature.
(Inherited from ENEQuery.) | |
NavERecsOffset |
Gets and sets the offset into the navigation record list for navigation query.
(Inherited from ENEQuery.) | |
NavERecsPerAggrERec |
Gets and sets the max number of records to be returned in each
aggregated record.
(Inherited from ENEQuery.) | |
NavExposedRefinements |
Gets and sets the set of refinements that should be exposed / returned
with the navigation query.
(Inherited from ENEQuery.) | |
NavKeyProperties |
Get and sets the number of key properties to be returned.
(Inherited from ENEQuery.) | |
NavMerchPreviewTime |
Gets and sets the merch preview time on this navigation query.
(Inherited from ENEQuery.) | |
NavMerchRuleFilter |
Gets and sets the merch rule filter on this navigation query.
(Inherited from ENEQuery.) | |
NavNumAggrERecs |
Gets and sets the max number of aggregated records returned for the
navigation query.
(Inherited from ENEQuery.) | |
NavNumBulkAggrERecs |
Gets and sets the max number of aggregated records returned
in bulk format for the navigation query.
If MAX_BULK_ERECS_AVAILABLE is passed to this method,
then all aggregated records for the navigation query will be returned.
(Inherited from ENEQuery.) | |
NavNumBulkERecs |
Gets and sets the max number of records returned in bulk format for the
navigation query. If MAX_BULK_ERECS_AVAILABLE is
passed to this method, then all records for the navigation query
will be returned.
(Inherited from ENEQuery.) | |
NavNumERecs |
Get and sets the max number of records returned for the navigation query.
(Inherited from ENEQuery.) | |
NavOpts |
Gets and sets the option set that navigation queries will use.
(Inherited from ENEQuery.) | |
NavRangeFilters |
Gets and sets the navigation range filters on this navigation query.
(Inherited from ENEQuery.) | |
NavRecordFilter |
Gets and sets the record filters on this navigation query.
(Inherited from ENEQuery.) | |
NavRecordStructureExpr |
Gets and sets the structure expression on this navigation query.
(Inherited from ENEQuery.) | |
NavRefinementConfigs |
Gets and sets the list of dynamic refinement
configs to be used by the MDEX Engine.
(Inherited from ENEQuery.) | |
NavRelRankERecRank |
Gets and sets the navigation relevance ranking record search to perform on the records
of the navigation query.
(Inherited from ENEQuery.) | |
NavRelRankERecSearch | Obsolete.
Gets and sets the navigation relevance ranking record search to perform on the records
of the navigation query.
(Inherited from ENEQuery.) | |
NavRollupKey |
Gets and sets the rollup key with which the records of the navigation
query should be rolled up with to create aggregated records.
(Inherited from ENEQuery.) | |
NavStratifiedDimVals |
Gets and sets the list stratified dim vals for use
during refinement ranking by the MDEX engine.
(Inherited from ENEQuery.) | |
Profiles |
Gets and sets the set of profiles that describe
the application end user.
(Inherited from ENEQuery.) | |
QueryInfo |
Gets and sets the ENEQueryInfo object.
(Inherited from ENEQuery.) | |
Selection |
Gets and sets the select list for the query.
(Inherited from ENEQuery.) |