ISearchIndexInfo Interface

Index info interface.

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public interface ISearchIndexInfo : IAdvancedDataContainer, 
	IDataContainer, ISimpleDataContainer

The ISearchIndexInfo type exposes the following members.

Properties

	Name	Description
Public property	ColumnNames	Column names. (Inherited from IDataContainer.)
Public property	HasChanged	Returns true if the object changed. (Inherited from IAdvancedDataContainer.)
Public property	IndexBatchSize	Gets or sets the batch size for data loading.
Public property	IndexCodeName	Gets index code name.
Public property	IndexProvider	Defines a provider which performs actions on search index.
Public property	IndexSettings	Search index settings for current object.
Public property	IndexType	Gets or sets the index type (documents, forums, etc).
Public property	IsComplete	Returns true if the object is complete (has all columns). (Inherited from IAdvancedDataContainer.)
Public property	Item	Gets or sets the value of the column. (Inherited from ISimpleDataContainer.)

Methods

	Name	Description
Public method	ChangedColumns	Returns list of column names which values were changed. (Inherited from IAdvancedDataContainer.)
Public method	ContainsColumn	Returns true if the object contains specified column. (Inherited from IDataContainer.)
Public method	DataChanged	Returns true if the object changed. (Inherited from IAdvancedDataContainer.)
Public method	GetOriginalValue	Returns the original value of column. (Inherited from IAdvancedDataContainer.)
Public method	GetValue	Returns value of column. (Inherited from ISimpleDataContainer.)
Public method	ItemChanged	Returns true if the item on specified column name changed. (Inherited from IAdvancedDataContainer.)
Public method	MakeComplete	Makes the object data complete. (Inherited from IAdvancedDataContainer.)
Public method	ResetChanges	Resets the object changes and keeps the new values as unchanged. (Inherited from IAdvancedDataContainer.)
Public method	RevertChanges	Reverts the object changes to the original values. (Inherited from IAdvancedDataContainer.)
Public method	SetValue	Sets value of column. (Inherited from ISimpleDataContainer.)
Public method	TryGetValue	Returns value of column. (Inherited from IDataContainer.)

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)