Click or drag to resize
DocumentSearchablesRetriever Class
Helps with retrieving ISearchable objects and SearchIndexInfos related to document search tasks.
Inheritance Hierarchy
SystemObject
  CMS.Search.InternalSearchablesRetriever
    CMS.DocumentEngine.InternalDocumentSearchablesRetriever

Namespace: CMS.DocumentEngine.Internal
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 11.0.0
Syntax
C#
public class DocumentSearchablesRetriever : SearchablesRetriever

The DocumentSearchablesRetriever type exposes the following members.

Constructors
  NameDescription
Public methodDocumentSearchablesRetriever
Top
Properties
  NameDescription
Protected propertyLogger
Logs progress of a search task.
(Inherited from SearchablesRetriever.)
Top
Methods
  NameDescription
Public methodGetRelevantIndexes(String, String)
Returns dataset of index IDs for specific type.
(Overrides SearchablesRetrieverGetRelevantIndexes(String, String).)
Public methodGetRelevantIndexes(ISearchable, String)
Gets the list of indexes relevant to the given object.
(Overrides SearchablesRetrieverGetRelevantIndexes(ISearchable, String).)
Public methodGetRelevantIndexes(String, String, String)
Gets relevant indexes for given indexType, siteName and searchProvider.
(Overrides SearchablesRetrieverGetRelevantIndexes(String, String, String).)
Public methodGetSearchableObject
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 methodGetSearchableObjects
Returns collection of all ISearchable objects for given indexInfo.
(Overrides SearchablesRetrieverGetSearchableObjects(SearchIndexInfo).)
Public methodIsObjectTypeIndexed
Indicates whether objectType is to be included in index.
(Inherited from SearchablesRetriever.)
Top
See Also