DocumentSearchablesRetriever Class

Helps with retrieving ISearchable objects and SearchIndexInfos related to document search tasks.

Inheritance Hierarchy

System.Object
  CMS.Search.Internal.SearchablesRetriever
    CMS.DocumentEngine.Internal.DocumentSearchablesRetriever

Namespace: CMS.DocumentEngine.Internal
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0

Syntax

public class DocumentSearchablesRetriever : SearchablesRetriever

The DocumentSearchablesRetriever type exposes the following members.

Constructors

	Name	Description
Public method	DocumentSearchablesRetriever

Properties

	Name	Description
Protected property	Logger	Logs progress of a search task. (Inherited from SearchablesRetriever.)

Methods

	Name	Description
Public method	GetRelevantIndexes(String, String)	Returns dataset of index IDs for specific type. (Overrides SearchablesRetriever.GetRelevantIndexes(String, String).)
Public method	GetRelevantIndexes(ISearchable, String)	Gets the list of indexes relevant to the given object. (Overrides SearchablesRetriever.GetRelevantIndexes(ISearchable, String).)
Public method	GetRelevantIndexes(String, String, String)	Gets relevant indexes for given indexType, siteName and searchProvider. (Overrides SearchablesRetriever.GetRelevantIndexes(String, String, String).)
Public method	GetSearchableObject	Returns ISearchable object for given index that satisfies conditions given by objectType, value and field. Returns null if no ISearchable object satisfies given conditions. (Inherited from SearchablesRetriever.)
Public method	GetSearchableObjects	Returns collection of all ISearchable objects for given indexInfo. (Overrides SearchablesRetriever.GetSearchableObjects(SearchIndexInfo).)
Public method	IsObjectTypeIndexed	Indicates whether objectType is to be included in index. (Inherited from SearchablesRetriever.)