ESearchReport Class

ESearchReport objects contain detailed information about record searches.

Declaration Syntax

Visual Basic

Visual C++

public class ESearchReport

Public Class ESearchReport

public ref class ESearchReport

Members

All Members	Methods	Properties	Fields
Public Protected		Instance Static

Icon	Member	Description
	AutoSuggestions	Returns the list of automatic spelling corrections and/or alternative phrasing suggestions made by the Endeca MDEX Engine.
	DYMSuggestions	Returns the list of "Did You Mean" suggestions made by the MDEX Engine
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ErrorMessage	Returns the MDEX Engine's error message if the search was not valid.
	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.)
	GetType()()	Gets the Type of the current instance. (Inherited from Object.)
	isValid()()	Determines if the search was a valid search.
	Key	Gets the name of the Endeca Dimension or Property key used in the search.
	MatchedMode	Returns the matched search mode that was selected by the MDEX Engine.
	MemberwiseClone()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	MODE_ALL	Match all user search terms (i.e., perform a conjunctive search). This is the default mode.
	MODE_ALL_ANY	Match all user search terms if possible, otherwise match at least one.
	MODE_ALL_PARTIAL	Match all user search terms if possible, otherwise match some.
	MODE_ANY	Match at least one user search term.
	MODE_BOOLEAN	Match using a Boolean query.
	MODE_PARTIAL	Match some user search terms.
	MODE_PARTIAL_MAX	Match a maximal subset of user search terms.
	MODE_UNKNOWN	The mode is unknown.
	NumMatchedTerms	Returns the number of search terms that were sucessfully matched when the search was performed.
	NumMatchingResults	Returns the number of records that matched the search.
	SearchMode	Gets the requested search mode used in the search.
	Terms	Gets the terms specified in the search.
	ToString()()	Returns a String that represents the current Object. (Inherited from Object.)
	TruncatedTerms	Returns a set of search terms after truncation.
	WordInterps	Returns the word interpretations for the record search.

Remarks

Use ESearchReports to obtain an IDictionary of ESearchReport objects.

A single ESearchReport object contains information about a single search key. If a query is submitted to the Endeca MDEX Engine with multiple keys, ESearchReports will return an IDictionary that contains an ESearchReport for each search key that was submitted.

For example, in this query:

CopyC#

N=0&Ntk=Name|Flavors&Ntt=merlot|fuity

the resulting IDictionary will have two entries: one for the Name search key and one for the Flavors search key.

Inheritance Hierarchy

Object
	ESearchReport

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