ForumInfoProvider Class

Class providing ForumInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<ForumInfo, ForumInfoProvider, ObjectQuery<ForumInfo>>
    CMS.DataEngine.AbstractInfoProvider<ForumInfo, ForumInfoProvider>
      CMS.Forums.ForumInfoProvider

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

Syntax

public class ForumInfoProvider : AbstractInfoProvider<ForumInfo, ForumInfoProvider>

The ForumInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	ForumInfoProvider	Constructor

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 Static member	AddModerator	Add moderator to forum, return moderator Id.
Public method Static member	AddRoleToForum	Adds specified role to the forum.
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 Static member	CheckLicense	Checks the license.
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>.)
Public method Static member	ClearLicCheck	Clear license limitations table.
Public method Static member	CombineSecurityWhereCondition	Add security where condition to the existing where condition.
Protected method	CombineSecurityWhereConditionInternal	Add security where condition to the existing where condition.
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 Static member	DeleteForumInfo(Int32)	Deletes specified forum.
Public method Static member	DeleteForumInfo(ForumInfo)	Deletes specified forum.
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>.)
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	GetForumIdsByForumName	Returns IDs of forums with specified name.
Public method Static member	GetForumInfo(Int32)	Returns the ForumInfo structure for the specified forum.
Public method Static member	GetForumInfo(String, Int32)	Returns the ForumInfo structure for the specified forum.
Public method Static member	GetForumInfo(String, Int32, Int32)	Returns the ForumInfo structure for the specified forum.
Public method Static member	GetForumInfoByDocument	Returns the ForumInfo structure for the specified document.
Protected method	GetForumInfoByDocumentInternal	Returns the ForumInfo structure for the specified document.
Public method Static member	GetForumInfoByGUID	Returns object with specified GUID.
Public method Static member	GetForums	Returns a query for all the ForumInfo objects.
Public method Static member	GetForumsCount	Returns the number of message boards related to the specified document.
Protected method	GetForumsCountInternal	Returns the number of message boards related to the specified document.
Public method Static member	GetForumSiteName	Returns site name with dependence on selected forum id.
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	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	GetInfoById	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>.)
Public method Static member	GetModerator	Returns forum id's to moderator assigned by user id.
Protected method	GetModeratorInternal	Returns forum id's to moderator assigned by user id.
Public method Static member	GetModerators	Returns DataSet with moderators(User) to specified forum.
Protected method	GetModeratorsInternal	Returns DataSet with moderators(User) to specified forum.
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>.)
Protected method	GetRoleNamesForForumInternal	Returns RoleNames in format rolename1;rolename2;rolename3....
Public method Static member	GetSearchDocuments	Returns search documents
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>.)
Public method Static member	IsAuthorizedPerForum	Indicates whether specified user has assigned specific permission for the specified forum.
Protected method	IsAuthorizedPerForumInternal	Indicates whether specified user has assigned specific permission for the specified forum.
Public method Static member	IsRoleAllowedForForum	Returns true if role is allowed for given forum.
Protected method	IsRoleAllowedForForumInternal	Returns true if role is allowed for given forum.
Public method Static member	LicenseVersionCheck	License version check.
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 Static member	MoveForumDown	Moves forum down in the order sequence (down = larger ForumpOrder = later in the navigation).
Protected method	MoveForumDownInternal	Moves forum down in the order sequence (down = larger ForumpOrder = later in the navigation).
Public method Static member	MoveForumUp	Moves forum up in the order sequence (up = smaller ForumOrder = sooner in the navigation).
Protected method	MoveForumUpInternal	Moves forum up in the order sequence (up = smaller ForumOrder = sooner in the navigation).
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 (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTaskInternal(String, String, Byte[]).)
Public method Static member	RefreshDataCount	Refresh threads and posts count.
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RemoveModerator	Remove moderator from forum id.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RemoveRoleFromForum	Removes the forum role assignment.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetForumInfo	Sets (updates or inserts) specified forum.
Protected method	SetInfo	Inserts or Updates the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
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	UpdateForumCountsInternal	Update threads, posts, last user and last time values.
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>.)
Protected method	UpdateQuestionSolvedInternal	Updates PostQuestionSolved field in threads. Sets true in threads where at least one post is marked as is answer (according to the forum AnswerLimit settings).
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)