A class composed of multiple records, all sharing a similarity.

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

Contains the result of an Analytics statement.

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

List of associated dimension location groups exposed as an IList.

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.

List of value intersection groups exposed as an IList.

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.

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

List of dimensions (Dimension objects).

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

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.

List of value intersection groups exposed as an IList.

Class encapsulating a group of dimensions.

List of dimension groups exposed as an IList.

DimLocation represents a specific location in a dimension.

List containing DimLocation objects exposed as an IList.

Class representing a refinement config for dimension search. The only option available in this class is the ability to turn counts on or off.

Class that encapsulates a collection of dimension search refinement config (DimSearchRefinementConfig) objects.

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

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

List of dimension value IDs.

A list of dimension values (DimVal objects).

This class represents the configuration of the Disabled Refinement results that will be returned with the query results. The methods of this class allow configuration of the base nav state to be used to compute the Disabled Refinements.

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.

The exception thrown when authentication fails

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

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.

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

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

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

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

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 class is composed of properties and dimension values it is tagged by.

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

Collection of record compound search keys exposed as an IList.

List containing ERec or AggrERec objects exposed as an IList.

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

List of Endeca records exposed as an IList.

Class representing a relevance ranking on a navigation record set.

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

Collection of record rollup keys exposed as an IList.

Class representing a search on a navigation record set.

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

Collection of record search keys exposed as an IList.

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

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

Collection of record sort keys exposed as an IList.

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

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

ESearchReport objects contain detailed information about record searches.

Enumeration of Endeca search modes.

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

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.

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

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

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

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.

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

Class representing an

CopyC#

bool

or an unset value. Unlike an

CopyC#

bool

, an

CopyC#

OptionalBool

may be empty.

Class representing an

CopyC#

int

or an unset value. Unlike an

CopyC#

int

, an

CopyC#

OptionalInt

may be empty.

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

Class representing an Endeca name/value property pair.

Class providing access to a collection of properties.

Class representing a range filter on a navigation record set.

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

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.

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

Class representing the assignment of a dimension value to a specific stratum for sorting. Dimension values are sorted by their assigned strata and then by whatever the refinement sorting method for the dimension is (via static ranking, dynamic ranking, dynamic refinement configs, etc). Dimension values not explicitly assigned a strata are assigned the strata 0.

Class that encapsulates a collection of stratified dimension values (StratifiedDimVal) objects.

Class representing supplemental information and data for a navigation query.

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

An object used for formulating queries to an Endeca MDEX Engine through the use of an input URL.

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

A generic toolkit for manipulating and generating URL query strings.

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.

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.

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.