Endeca Presentation API
ERecSearch Class
NamespacesEndeca.NavigationERecSearch
Class representing a search on a navigation record set.
Declaration Syntax
C#Visual BasicVisual C++
public class ERecSearch
Public Class ERecSearch
public ref class ERecSearch
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
ERecSearchERecSearchNew()()
Default empty constructor.

ERecSearchERecSearchNew(String, String)
Constructor specifying the key and the terms of the search.

ERecSearchERecSearchNew(String, String, String)
Constructor specifying the key, terms, and options of the search.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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.)
Key
Gets the key of this ERecSearch.

MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Opts
Gets the options of this ERecSearch

Terms
Gets the terms of this ERecSearch.

ToString()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
A record search is composed of three elements:

  • search keyThe name of an Endeca property or dimension (if enabled for record search) or an Endeca search interface. The search key indicates which field of the records to search the terms against.
  • termsThe strings that are being searched, such as raspberry flavor (which may be a quoted phrase).
  • optionsThe search options, such as the search mode (e.g., mode matchany) and relevance ranking options. This element is optional and can therefore be null.

Note that ERecSearch objects are encapsulated in ERecSearchList objects when sent to or returned from the MDEX Engine.

Inheritance Hierarchy
Object
ERecSearch

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