UrlENEQuery Class

[Missing <summary> documentation for T:Endeca.Navigation.UrlENEQuery]

Declaration Syntax

Visual Basic

Visual C++

[SerializableAttribute]
public class UrlENEQuery : ENEQuery

<SerializableAttribute> _
Public Class UrlENEQuery _
	Inherits ENEQuery

[SerializableAttribute]
public ref class UrlENEQuery : public ENEQuery

Members

Icon	Member	Description
	UrlENEQueryUrlENEQueryNew()()	No argument constructor.
	UrlENEQueryUrlENEQueryNew(String)	Obsolete. Obsolete. Use the constructor that takes an encoding instead.
	UrlENEQueryUrlENEQueryNew(String, String)	Constructor where the queryString gets parsed into the individual query fields.
	AddSelection(String)	Adds the field named fieldName to the set of fields that should be returned for each record in the result set. (Inherited from ENEQuery.)
	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 aggreageted record rollup keys.
	AGGR_EREC_STRUCTURE_EXPR_PARAM	Parameter name for aggregated record structure expression.
	AggrERec	Obsolete. Gets or sets the Id of the aggregated record to be queried for. (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.)
	ANALYTICS_PARAM	Parameter name for Analytics query
	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.)
	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.)
	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_RESULTS_OFFSET_PARAM	Parameter name for dimension search results offset.
	DIM_SEARCH_TERMS_PARAM	Parameter name for dimension search terms.
	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	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.)
	DimSearchResultsOffset	Gets and sets the offset with which the dimension search will begin returning results per dimension. (Inherited from ENEQuery.)
	DimSearchTerms	Gets and sets the search terms the dimension search will use. (Inherited from ENEQuery.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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.)
	ERECS_PARAM	Parameter name for records.
	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. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
	GetNavActiveSortKeys()()	Get the list of sort keys with which the navigation query's records will be sorted. (Inherited from ENEQuery.)
	GetNavSortKey()()	Gets the sort key with which the navigation query's records will be sorted. (Inherited from ENEQuery.)
	GetNavSortOrder()()	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.)
	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.)
	MemberwiseClone()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	NAV_AGGR_ERECS_OFFSET_PARAM	Parameter name for navigation aggregated record list offset.
	NAV_DESCRIPTORS_PARAM	Parameter name for navigation values.
	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_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.
	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.)
	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.)
	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	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.)
	Profiles	Gets and sets the set of profiles that describe the application end user. (Inherited from ENEQuery.)
	QUERY_ID_PARAM	Parameter name for Request Id
	QueryInfo	Gets and sets the ENEQueryInfo object. (Inherited from ENEQuery.)
	Selection	Gets and sets the select list for the query. (Inherited from ENEQuery.)
	SESSION_ID_PARAM	Parameter name for Session Id
	SetA(String)	Sets the aggregated record for the query. AggrERec.
	SetAf(String)	Sets the aggregated record navigation range filters. AggrERecNavRangeFilters.
	SetAn(String)	Sets the aggregated record navigation values for the query. AggrERecNavDescriptors.
	SetAr(String)	Sets the aggregated record navigation record filter. AggrERecNavRecordFilter.
	SetArs(String)	Sets the aggregated record structure expression. AggrERecStructureExpr.
	SetAu(String)	Sets the aggregated record rollup key with which the aggregated record is derived. AggrERecRollupKey.
	SetD(String)	Sets the string dimension search query terms. DimSearchTerms.
	SetDf(String)	Sets the dimension search navigation range filters. DimSearchNavRangeFilters.
	SetDi(String)	Sets the dimension(s) with which to dimension search in. DimSearchDimensions.
	SetDk(String)	Sets the dimension search behavior to order results. DimSearchRankResults.
	SetDn(String)	Sets the navigation restriction for the dimension search. DimSearchNavDescriptors
	SetDo(String)	Sets the dimension search results offset. DimSearchResultsOffset.
	SetDp(String)	Sets the number of results to return per dimension. DimSearchNumDimValues
	SetDr(String)	Sets the dimension search navigation record filter. DimSearchNavRangeFilters.
	SetDrs(String)	Sets the dimension search navigation structure expression. DimSearchNavRecordStructureExpr.
	SetDx(String)	Sets the dimension search options. DimSearchOpts.
	SetN(String)	Sets the navigation field of the query. NavDescriptors
	SetNa(String)	Sets an analytics query. AnalyticsQuery
	SetNao(String)	Sets the navigation aggregated record list offset. NavAggrERecsOffset
	SetNavActiveSortKeys(ERecSortKeyList)	Set the list of sort keys with which the navigation query's records will be sorted. (Inherited from ENEQuery.)
	SetNavSortKey(String)	Sets the sort key with which the navigation query's records will be sorted. (Inherited from ENEQuery.)
	SetNavSortOrder(Int32)	Sets the sort order with which the navigation query's records will be sorted. (Inherited from ENEQuery.)
	SetNe(String)	Sets the exposed navigation refinements. NavExposedRefinements
	SetNf(String)	Sets the range filters for the navigation query. NavRangeFilters.
	SetNk(String)	Sets the key properties request for the navigation query. NavKeyProperties
	SetNmpt(String)
	SetNmrf(String)
	SetNo(String)	Sets the navigation record list offset. NavERecsOffset
	SetNp(String)	Sets the number of records per aggregated record. NavERecsPerAggrERec
	SetNr(String)	Sets the record filter for the navigation query. NavRecordFilter.
	SetNrc(String)	Sets the list of dynamic refinement configs for the navigation query. Dynamic refinement configs are delimited by '\|'.
	SetNrk(String)	Sets the key of the record search of the navigation query using a specified relevance ranking strategy.
	SetNrm(String)	Sets the relevance ranking match mode for the record search of the navigation query.
	SetNrr(String)	Sets the relevance ranking strategy for the record search of the navigation query.
	SetNrs(String)	Sets the structure expression for the navigation query. NavRecordStructureExpr.
	SetNrt(String)	Sets the terms of the record search of the navigation query using a specified relevance ranking strategy.
	SetNs(String)	Sets the sort key for the record list of the navigation.
	SetNso(String)	Sets the sort order for the record list of the navigation.
	SetNtk(String)	Sets the keys of the record search of the navigation query.
	SetNtpc(String)	Sets whether the compute-autophrase record search functionality is on in the query. NavERecSearchComputeAlternativePhrasings
	SetNtpr(String)	Sets whether the rewrite-autophrase record search functionality is on in the query. NavERecSearchRewriteQueryWithAnAlternativePhrasing
	SetNtt(String)	Sets the terms of the record search of the navigation query.
	SetNtx(String)	Sets the options for the record search of the navigation query.
	SetNty(String)	Sets whether the did you mean record search functionality is on in the query. NavERecSearchDidYouMean
	SetNu(String)	Sets the rollup key for the navigation query. NavRollupKey
	SetR(String)	Sets the records for query. ERecs.
	ToQueryString(ENEQuery, String)	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.

Inheritance Hierarchy

Object
	ENEQuery
		UrlENEQuery

Assembly: Endeca.Navigation (Module: Endeca.Navigation) Version: 0.0.0.0

All Members	Constructors	Methods	Properties	Fields
Public Protected		Instance Static		Declared Inherited