Endeca Presentation API
Endeca.Navigation Namespace
NamespacesEndeca.Navigation
Provides an interface to query the Endeca MDEX Engine and a structure of objects to handle the data returned from the query.
Declaration Syntax
C#Visual BasicVisual C++
namespace Endeca.Navigation
Namespace Endeca.Navigation
namespace Endeca.Navigation
Types
All TypesClassesInterfacesEnumerations
IconTypeDescription
AggrERec
A class composed of multiple records, all sharing a similarity.

AggrERecList
List of Endeca aggregated records (AggrERec objects) exposed as an IList.

AnalyticsStatementResult
Contains the result of an Analytics statement.

AssocDimLocations
Class encapsulating a list of dimension locations associated by their dimension.

AssocDimLocationsList
List of associated dimension location groups exposed as an IList.

AssocNavigationRefs
Class encapsulating a group of value intersection references that all share a similar set of dimensions. That is, every set of values in this group are from the same set of dimensions.

AssocNavigationRefsList
List of value intersection groups exposed as an IList.

AuthHttpENEConnection
An extention of HttpENEConnection that provides connections to Endeca MDEX Engines that require authentication. Use instances of this class to connect to an Endeca MDEX Engine via the Endeca Access Control System.

Dimension
Core component of a navigation state query encapsulating all information known about a dimension at the navigation state.

DimensionList
List of dimensions (Dimension objects).

DimensionSearchResult
Result class for a value search query. Class includes values queried for as well as other information about the query.

DimensionSearchResultGroup
Class encapsulating a group of value intersection references that all share a similar set of dimensions. That is, every set of values in this group are from the same set of dimensions.

DimensionSearchResultGroupList
List of value intersection groups exposed as an IList.

DimGroup
Class encapsulating a group of dimensions.

DimGroupList
List of dimension groups exposed as an IList.

DimLocation
DimLocation represents a specific location in a dimension.

DimLocationList
List containing DimLocation objects exposed as an IList.

DimSearchResult
Result class for a value search query. Class includes values queried for as well as other information about the query.

DimVal
A dimension value is the lowest-level building block that compose dimensions, navigations, and classifications of records.

DimValIdList
List of dimension value IDs.

DimValList
A list of dimension values (DimVal objects).

RefinementConfig..::DynamicRankingState
RefinementConfig..::DynamicRankOrderState
EmptyENEQueryException
Exception signalling that the query method was called with an empty query object. Exception comes from the fact that a query object did not express any requests to the Endeca MDEX Engine.

ENEAuthenticationException
The exception thrown when authentication fails

ENEConnectionException
Exception represents an error dealing with the communication with an Endeca MDEX Engine from an IENEConnection.

ENEException
Exception represents an exception that comes from the Endeca MDEX Engine. Often this means that the IENEConnection was able to contact the MDEX Engine but the MDEX Engine responded with an error.

ENEQuery
An object used for expressing queries to an Endeca MDEX Engine.

ENEQueryException
Abstract exception representing a general error while attempting to query the Endeca MDEX engine.

ENEQueryInfo
An object that generates and stores logging-specific query information.

ENEQueryResults
Result object returned from a query to an Endeca MDEX Engine.

ENEQueryToolkit
ENEQueryToolkit provides static methods for managing the value of the primary URL query parameter in a navigation query. This parameter specifies the list of refinement dimensions that were used to generate the current query results. Managing the parameter's value allows you to maintain application state.

ERec
ERec class is composed of properties and dimension values it is tagged by.

ERecCompoundSearchKey
Key with which a record set can be or is text group searched by.

ERecCompoundSearchKeyList
Collection of record compound search keys exposed as an IList.

ERecEnumerator
List containing ERec or AggrERec objects exposed as an IList.

ERecIdList
List of record specifications. Primarily used to generate URLs and MDEX Engine queries.

ERecList
List of Endeca records exposed as an IList.

ERecRank
Class representing a relevance ranking on a navigation record set.

ERecRollupKey
Key with which a record set can or is rolled up by.

ERecRollupKeyList
Collection of record rollup keys exposed as an IList.

ERecSearch
Class representing a search on a navigation record set.

ERecSearchKey
Key with which a record set can be or is text searched by.

ERecSearchKeyList
Collection of record search keys exposed as an IList.

ERecSearchList
Class that encapsulates a collection of ERecSearch objects, each of which represents a record search.

ERecSortKey
Key with which a record set can or is sorted by.

ERecSortKeyList
Collection of record sort keys exposed as an IList.

ESearchAutoSuggestion
ESearchAutoSuggestion represents a single alternate spelling suggestion made by the Endeca MDEX Engine when a record search is performed.

ESearchDYMSuggestion
ESearchDYMSuggestion represents a single alternate spelling suggestion made by the Endeca MDEX Engine when a text search is performed.

ESearchReport
ESearchReport objects contain detailed information about record searches.

ETInstrumentor
Class that instruments HTML pages for use with the Web-based tools package.

FieldList
An IList of Endeca property or dimension names that will be used to specify which values will be returned for each record in the result set of a navigation query. The Selection setter property is used to set the FieldList for the query.

HttpENEConnection
Provides a connection to an Endeca MDEX Engine over HTTP. Also provides a mechanism for issuing queries to the MDEX Engine.

IENEConnection
A connection with an Endeca MDEX Engine. With a connection, queries can be issued to the MDEX Engine and ENEQueryResults are returned.

The only current type of connection offered is the HttpENEConnection.


InternalException
Exception signalling that an internal error has occured in the system. Internal errors often signal an unexpected error in the execution of the system.

IPropertyContainer
Interface for an object that has properties and has those properties exposed as a PropertyMap. The purpose for this interface is to allow common code to be used in the extraction of any object that supports this interface, for example building tag libraries around property containers.

KeyProperties
Class providing access to a collection of properties associated with a given Endeca Dimension or Property key.

ESearchReport..::Mode
Enumeration of Endeca search modes.

Navigation
Top-level object returned from an Endeca MDEX Engine. The Navigation object serves as a container for several components (such as navigation descriptors, record set, etc.) that together compose a navigation.

NavigationRefsList
List of navigation refinement values exposed as an IList. Each element of the list is a DimValList referencing a navigation state.

OptionalInt
Class representing an
CopyC#
int
or an unset value. Unlike an
CopyC#
int
, an
CopyC#
OptionalInt
may be empty.

PartialENEQueryException
Exception that is triggered if there is a query that does not completely express a query with all necessary parameter.

Property
Class representing an Endeca name/value property pair.

PropertyMap
Class providing access to a collection of properties.

RangeFilter
Class representing a range filter on a navigation record set.

RangeFilterList
Class that encapsulates a collection of range filters (RangeFilter objects).

RefinementConfig
Class representing a dynamic refinement config for a dimension value. This will determine how refinements are computed under this dimension value. Use of a dynamic refinement config will suppress generation of a "More..." child dimension value. You can determine whether there are more refinements than the ones shown by looking at the "DGraph.More" property on the refinements' parent dimension value. Any of the settings in this class can be set explicitly or defaulted to use the corresponding dimension's settings in developer studio.

RefinementConfigList
Class that encapsulates a collection of dynamic refinement config (RefinementConfig) objects.

Supplement
Class representing supplemental information and data for a navigation query.

SupplementList
List of supplements (Supplement objects) exposed as an IList.

UrlENEQuery
UrlENEQueryParseException
Exception representing an error while parsing a URL for a UrlENEQuery.

UrlGen
A generic toolkit for manipulating and generating URL query strings.

VersionMismatchException
Exception signalling the mismatch of two incompatible modules in the system while processing the query. Most often this exception is used to signal a mismatch between the IENEConnection and the Endeca MDEX Engine itself.