SearchIndexSiteInfoProvider Class

Class providing management of the Search index - Site binding.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<SearchIndexSiteInfo, SearchIndexSiteInfoProvider, ObjectQuery<SearchIndexSiteInfo>>
    CMS.DataEngine.AbstractInfoProvider<SearchIndexSiteInfo, SearchIndexSiteInfoProvider>
      CMS.Search.SearchIndexSiteInfoProvider

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 13.0.131

Syntax

public class SearchIndexSiteInfoProvider : AbstractInfoProvider<SearchIndexSiteInfo, SearchIndexSiteInfoProvider>, 
	ISearchIndexSiteInfoProvider, IInfoProvider<SearchIndexSiteInfo>

The SearchIndexSiteInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	SearchIndexSiteInfoProvider

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Public method	Add	Creates SearchIndexSiteInfo binding.
Public method Static member	AddSearchIndexToSite	Obsolete. Creates search index site binding.
Protected method	AddSearchIndexToSiteInternal	Obsolete. Creates search index site binding.
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteSearchIndexSiteInfo(SearchIndexSiteInfo)	Obsolete. Deletes specified search index site binding.
Public method Static member	DeleteSearchIndexSiteInfo(Int32, Int32)	Obsolete. Deletes specified search index site binding.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32, Int32)	Gets an instance of the SearchIndexSiteInfo binding structure.
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of the SearchIndexSiteInfo binding structure.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetIndexSiteBindings	Returns search index site bindings for specified indexes.
Protected method	GetIndexSiteInfosFromIndexesInternal	Returns object query with search index site bindings for the specified indexes.
Protected method	GetIndexSiteInfosFromSitesInternal	Returns object query with search index site bindings for the specified sites.
Public method Static member	GetIndexSites	Returns all sites for specified search indexes.
Protected method	GetIndexSitesInternal	Returns object query with all sites for specified search indexes.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetSearchIndexSiteInfo	Obsolete. Returns search index site binding structure for the specified index and site.
Protected method	GetSearchIndexSiteInfoInternal	Obsolete. Returns the SearchIndexSiteInfo structure for the specified index and site. Null if binding doesn't exist.
Public method Static member	GetSearchIndexSites	Obsolete. Returns all search index sites bindings.
Public method Static member	GetSiteIndexBindings	Returns search index site bindings for specified sites.
Public method Static member	GetSiteIndexes	Returns all indexes for specified sites.
Protected method	GetSiteIndexesInternal	Returns object query with all search indexes for specified sites.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Remove	Deletes SearchIndexSiteInfo binding.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SearchIndexHasAnySite	Returns >true if given search index has any site assigned, false otherwise.
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetSearchIndexSiteInfo	Obsolete. Sets specified searchIndexSite.
Protected method	SetSearchIndexSiteInfoInternal	Obsolete. Sets specified search index site binding.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)