The Endeca RAD Toolkit .NET API: an abstraction of the Endeca Presentation API. The RAD API includes both input and output types and presents a more standard interface to .NET developers.

Classes

  ClassDescription
AggregateRecord
An aggregated record from the MDEX Engine. This results from either a , or a with an AggregationKey parameter specified. The aggregated records feature allows the end user to group records by dimension or property values.
AggregateRecordDetailsCommand
Command to retrieve a single aggregate record from the MDEX Engine.
AggregateRecordsResult
Bundled result containing the collection of AggregateRecords, total record count, and total aggregate record count resulting from a
AnalyticsDataSet
A data set of AnalyticsDataTables, containing results of analytics queries sent to the MDEX engine.
AnalyticsDataTable
Encapsulates an analytics statement query result. Extends DataTable.
AnalyticsException
Represents the exception that is thrown when an error occurred parsing or executing an analytics query.
AnalyticsUtility
Creates DataSet objects from analytics results
AppliedFiltersResult
Groups together information related to restricting the set of records that is returned by the MDEX engine in response to a navigation query.
AttributeMetadata
Represents metadata describing a property such as the property's type and whether it is searchable, sortable, or can act as an aggregation key.
AttributeMetadataCollection
A collection of AttributeMetadata instances. The indexer looks up items by Name.
AuthenticationException
Represents the exception that is thrown when an an authentication failure error occurred while connecting to or executing a query against the MDEX engine.
BusinessRule
Represents a dynamic business rule that has been triggered by a query.
ChangeNotifyKeyedCollection<(Of <(TKey, TItem>)>)
KeyedCollection that raises an event whenever items are added to or removed from the collection.
Cluster
Represents a cluster of terms that can group Endeca records.
CommandParameterPropertyAttribute
Indicates that a property represents a value that acts as input to a query to the MDEX Engine.
CommandSerialization
Provides support for converting EndecaCommand instances to and from strings.
CommandSerializationContext
Provides additional contextual information for use by a CommandSerializationProvider when serializing or deserializing a command.
CommandSerializationProvider
Base class for classes that can convert EndecaCommand instances to and from a string-based representation.
CommandSerializationProviderCollection
A collection of CommandSerializationProvider instances.
CompoundDimensionSearchCommand
Command to retrieve all combinations of DimensionValues that match some or all of a set of specified search terms from the MDEX Engine.
CompoundDimensionSearchResult
Contains the results of a CompoundDimensionSearchCommand.
CompoundDimensionSearchResultHolder
Utility class to hold the results of the CompoundDimensionSearchCommand This class is not expected to be used unless a user is working with the
CopyC#
UrlManager
and the corresponding
CopyC#
CommandInfo
.
ConnectionException
Represents the exception that is thrown when an error occurred while connecting to an MDEX server.
DefaultCommandSerializationProvider Obsolete.
Serializes and deserializes EndecaCommand instances to and from a string representation.
Dimension
Represents a set of static information that descrbes a dimension in the MDEX engine.
DimensionSearchCommand
Command to retrieve the set of DimensionValues that match a given set of search terms from the MDEX Engine.
DimensionSearchResult
Contains the results of a DimensionSearchCommand.
DimensionSearchResultHolder
Utility class to hold the results of the DimensionSearchCommand This class is not expected to be used unless a user is working with the
CopyC#
UrlManager
and the corresponding
CopyC#
CommandInfo
classes.
DimensionState
Represents a dynamic view of a Dimension, appropriate for a user's current navigation state.
DimensionStateGroup
Represents a named group of dimensions.
DimensionStateGroupCollection
A collection of DimensionStateGroup instances, keyed by Name.
DimensionStatesResult
This class represents the current DimensionStates of all applicable Dimensions in the MDEX Engine. This class can also filter the complete set of DimensionStates to include any combination of refinable, fully implicit, and fully selected DimensionStates and to group any combination of DimensionStates by Dimension group.
DimensionValue
Represents a node in the hierarchy of values associated with a dimension.
DimensionValueCollection
Class representing an IndexedCollection<(Of <(T>)>) with numerous helper methods such as the ability to get the root DimensionValues or the DimensionValuePaths for all contained DimensionValues and the ability to create IDictionary<(Of <(TKey, TValue>)>) collections containing DimensionValues organized by Dimension.
DimensionValuePath
A collection of DimensionValue instances representing the path from the first dimension value to the last dimension value.
DisconnectedDimensionValue
The disconnected dimension value is similar to a normal DimensionValue except that it does not know its parent, dimension value path, or dimension due to a limitation in the MDEX Engine. A NotSupportedException will be thrown if any of the following properties are accessed for a disconnected dimension value: Parent, DimensionValuePath, and Dimension
EmptyQueryException
Exception thrown when a EndecaCommand is excuted, without setting any properties that express a valid query to the MDEX engine.
EndecaParameter
A parameter to be passed to the MDEX Engine.
EndecaParameterCollection
A collection of parameters for an MDEX Engine command that are indexed by name.
Geocode
Represents a Geocode location specified by latitude and longitude coordinates.
IndexedCollection<(Of <(T>)>)
IndexedCollection is a collection that provides lookup by Name or Id. It is intended to contain DimensionState and DimensionValue objects.
InvalidAnalyticsParametersException
Represents the exception that is thrown when an error occurred parsing or executing an analytics query.
MetadataCommand
Command to retrieve engine metadata such as property data, sort keys, search keys, and aggregation keys.
MetadataResult
Encapsulates static metatdata about the MDEX Engine such as property data, sort keys, search keys, and aggregation keys.
MultipleRecordDetailsCommand
Command to retrieve record details for several Records from the MDEX Engine.
NavigationCommand
Command to retrieve all navigation-related results from the MDEX Engine. These results will contain Records, Aggregate Records, Applied Filters, DimensionStates, and MetaData.
NavigationResult
Contains all navigation-related results from the MDEX Engine. This result aggregates the contents of RecordsResult, AggregateRecordsResult, AppliedFiltersResult, DimensionStatesResult, AnalyticsDataSet, MetadataResult, BusinessRule, and Cluster.
PartialQueryException
Exception thrown when an EndecaCommand is excuted, when setting only a subset of the properties that express a valid query to the MDEX engine.
PropertyChangeNotifyKeyedCollection<(Of <(TKey, TItem>)>)
A KeyedCollection that raises CollectionChanged()()() whenever a property value of an item in the collection changes.
PropertyConvert
A collection of methods to assist in parsing string values returned by the MDEX Engine into equivalent .NET primitive types.
PropertyMap
A multi-map like collection of PropertyValue instances.
PropertyValue
A key-value pair representing an instance of a property defined in the MDEX Engine.
RangeFilter
Represents a range filter on a record set.
ReadOnlyDictionary<(Of <(TKey, TValue>)>)
A dictionary that is restricted to read-only operations.
Record
Represents a individual Endeca record from the data set stored in an MDEX Engine.
RecordAttribute
Contains the name of a property or dimension.
RecordAttributeCollection
RecordDetailsCommand
Command to retrieve record details for a single Record from the MDEX Engine.
RecordsResult
Groups together the information relating to records that is returned by the MDEX engine in response to executing a NavigationCommand.
RefinementConfig
Class representing a dynamic refinement config for a DimensionValue. This will determine how refinements are computed under this DimensionValue. Each DimensionValue in a RefinementConfig is automatically opened, and has options for controlling the number of DimensionValues displayed under it, whether dynamic ranking is used for these dimension values, and the sort order of the dimension values.
RefinementConfigCollection
A collection of RefinementConfig objects keyed by DimensionValueId.
ReflectionCommandSerializationProvider
Reflects over EndecaCommand instances and serializes and deserializes properties that have been decorated with CommandParameterPropertyAttribute.
Search
Represents a record search.
SearchAdjustment
Represents a single alternate search adjustment made by the MDEX Engine when a record search is performed. The suggestion may or may not have been applied to the result set.
SearchKey
Represents the name of a property or interface that may be searched against.
SearchKeyCollection
Wraps a list of property names enabled for searching and search interfaces.
SearchReport
Represents a description of a text search executed by the MDEX Engine. This class describes the text search issued to the MDEX Engine when a query was made, as well as additional spelling corrections and suggestions performed by the MDEX Engine when processing the search.
Sort
Represents a description that indicates that record should be sorted by a particular property.
SortCollection
StratifiedDimConfig
Represents a description that indicates that record should be sorted by a particular property.
UserProfile
Contains the name of a user profile.
UserProfileCollection

Interfaces

  InterfaceDescription
IAttributeMap
Represents a read-only collection of IAttributeValue instances. This collection provides a multi-map like abstraction, in which multiple IAttributeValue instances that share a key can be present in the collection.
IAttributeValue
Interface that provides a uniform way to access property or dimension values from the MDEX Engine
INameAndId
This interface promises a string Name and string Id attributes. It is used by IndexedCollection<(Of <(T>)>) to provide lookup by name or ID. Only DimensionState and DimensionValue implement this interface.

Enumerations

  EnumerationDescription
AdjustmentTypes
The types of possible adjustments made to original search terms.
AlternativePhrasingMode
Enumerates the possible values of AlternativePhrasingMode.
DimensionStateTypes
Enumeration of possible states of a DimensionState. These are typically used to filter DimensionStates. They describe DimensionStates that have refinement DimensionValues, are fully selected (containing only already selected DimensionValues), or are fully implicit (containing only implicit DimensionValues.
MultiSelect
The selection capabilities of the dimension or dimension value.
RangeFilterOperator
An enumeration of available range filter types used by RangeFilter.
RecordsPerAggregateRecord
Enumerates the available choices for specifying how may constituent records to include with each AggregateRecord.
SearchMode
An enumeration of available search match modes used by Search and SearchKey
SortDirection
An enumeration of available sorting directions used by Sort.
SortType
An emuration of possible sort types used by Sort Either alphanumeric or geocode.