Class AbstractInfoProvider<TInfo, TProvider>

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Abstract info class provider.

public abstract class AbstractInfoProvider<TInfo, TProvider> : AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<TInfo>, IInfoProvider<TInfo>, IInfoByIdProvider<TInfo>, IInfoByGuidProvider<TInfo>, IInfoByNameProvider<TInfo>, IBulkInfoProvider<TInfo> where TInfo : AbstractInfoBase<TInfo>, new() where TProvider : AbstractInfoProvider<TInfo, TProvider>

Type Parameters

TInfo

TProvider

Inheritance

object

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>

AbstractInfoProvider<TInfo, TProvider>

Implements

IInfoProvider

ICustomizableProvider

IBulkOperationProvider

IWebFarmProvider

IInfoValidator<TInfo>

IInfoProvider<TInfo>

IInfoByIdProvider<TInfo>

IInfoByGuidProvider<TInfo>

IInfoByNameProvider<TInfo>

IBulkInfoProvider<TInfo>

Derived

ActivityInfoProvider

ActivityTypeInfoProvider

AccountContactInfoProvider

AccountInfoProvider

AccountStatusInfoProvider

ContactGroupInfoProvider

ContactGroupMemberInfoProvider

ContactInfoProvider

ContactRoleInfoProvider

ContactStatusInfoProvider

VisitorToContactInfoProvider

ChannelInfoProvider

ContentFolderInfoProvider

ContentLanguageInfoProvider

ContentTypeChannelInfoProvider

DataClassInfoProviderBase<TProvider>

GeneralInfoProvider

QueryInfoProvider

SettingsCategoryInfoProvider

SettingsKeyInfoProvider

TempFileInfoProvider

ConsentAgreementInfoProvider

ConsentArchiveInfoProvider

ConsentInfoProvider

AttachmentForEmailInfoProvider

EmailAttachmentInfoProvider

EmailInfoProvider

EmailChannelInfoProvider

EmailChannelSenderInfoProvider

EmailConfigurationInfoProvider

EmailLinkInfoProvider

EmailStatisticsHitsInfoProvider

EmailStatisticsInfoProvider

EmailTemplateContentTypeInfoProvider

EmailTemplateInfoProvider

EmailBounceInfoProvider

EmailMarketingRecipientInfoProvider

EmailSubscriptionConfirmationInfoProvider

RecipientListSettingsInfoProvider

SendConfigurationInfoProvider

EventLogProvider

AlternativeFormInfoProvider

CountryInfoProvider

StateInfoProvider

ResourceStringInfoProvider

ResourceTranslationInfoProvider

MacroIdentityInfoProvider

MacroRuleCategoryInfoProvider

MacroRuleInfoProvider

MacroRuleMacroRuleCategoryInfoProvider

UserMacroIdentityInfoProvider

MediaFileInfoProvider

MediaLibraryInfoProvider

ApplicationPermissionInfoProvider

ExternalLoginInfoProvider

MemberExternalLoginInfoProvider

MemberInfoProvider

RoleInfoProvider

UserInfoProvider

UserRoleInfoProvider

ResourceInfoProvider

BizFormInfoProvider

BizFormItemProvider

BizFormRoleInfoProvider

FormFeaturedFieldInfoProvider

TrackedWebsiteInfoProvider

WebFarmServerInfoProvider

WebFarmServerTaskInfoProvider

WebFarmTaskInfoProvider

WebsiteChannelInfoProvider

Inherited Members

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.infos

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.TypeInfo

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.ProviderObject

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.HashtableSettings

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.IsValid

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.DataSource

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.InfoObject

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.InvalidCodenameErrorMessageKey

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.Init(ObjectTypeInfo, HashtableSettings)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.InitTypeInfoAndRegister(ObjectTypeInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.CreateInfo(DataRow, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoById(int, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoByIdAsync(int, bool, CancellationToken)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfosByIds(IEnumerable<int>)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoByCodeName(string, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoByCodeNameAsync(string, bool, CancellationToken)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoByFullName(string, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoByGuid(Guid, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetInfoByGuidAsync(Guid, bool, CancellationToken)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.BulkDelete(IWhereCondition, BulkDeleteSettings)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.CreateDefaultBulkInsertSettings()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.BulkInsertInfos(IEnumerable<BaseInfo>)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.Validate(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.SetInfo(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.SetInfoAsync(TInfo, CancellationToken)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.CheckObject(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.ValidateCodeName(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.CheckUniqueCodeName(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.DeleteInfo(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.DeleteInfoAsync(TInfo, CancellationToken)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.BeginTransaction()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.UpdateData(IWhereCondition, IEnumerable<KeyValuePair<string, object>>, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.UpdateData(IEnumerable<KeyValuePair<string, object>>, IWhereCondition, bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.UpdateData(string, QueryDataParameters, string)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.UpdateData(string, QueryDataParameters, IWhereCondition)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetObjectQuery()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetDeleteQuery()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.GetObjectQueryInternal()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.InitHashtableSettings(ObjectTypeInfo, HashtableSettings)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.RegisterObjectInHashtables(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.RemoveOriginalCodeNameFromHashtable(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.UpdateObjectInHashtables(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.DeleteObjectFromHashtables(TInfo)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.LoadInfos()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.LoadAllInfos()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.ClearHashtables(bool)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.SetAsDefaultProvider()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.Invalidate()

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.CreateWebFarmTask(string, string)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.CreateWebFarmTask(string, string, byte[], string)

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.ProcessWebFarmTask(string, string, byte[])

AbstractInfoProvider<TInfo, TProvider, ObjectQuery<TInfo>>.ProcessWebFarmTaskInternal(string, string, byte[])

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

InfoProviderBulkExtensions.BulkDelete<TInfo>(IInfoProvider<TInfo>, IWhereCondition, BulkDeleteSettings)

InfoProviderBulkExtensions.BulkInsert<TInfo>(IInfoProvider<TInfo>, IEnumerable<TInfo>, BulkInsertSettings)

InfoProviderBulkExtensions.BulkUpdate<TInfo>(IInfoProvider<TInfo>, IEnumerable<KeyValuePair<string, object>>, IWhereCondition, bool)

InfoProviderBulkExtensions.BulkUpdate<TInfo>(IInfoProvider<TInfo>, string, QueryDataParameters, IWhereCondition)

Constructors

AbstractInfoProvider()

Initializes a new instance of the AbstractInfoProvider<TInfo, TProvider, TQuery> class.

protected AbstractInfoProvider()

Remarks

Calling this constructor is equivalent to calling AbstractInfoProvider(bool) while specifying true for the initialize parameter.

AbstractInfoProvider(ObjectTypeInfo)

Initializes a new instance of the AbstractInfoProvider<TInfo, TProvider, TQuery> class using the typeInfo provided.

protected AbstractInfoProvider(ObjectTypeInfo typeInfo)

Parameters

typeInfo ObjectTypeInfo

Object type information.

Remarks

Associate the InfoCacheAttribute with TInfo to configure the info cache. If not configured, default settings with UseWeakReferences set to true are used.

AbstractInfoProvider(bool)

Initializes a new instance of the AbstractInfoProvider<TInfo, TProvider, TQuery> class.

protected AbstractInfoProvider(bool initialize)

Parameters

initialize bool

Indicates if provider together with hashtables should be initialized.

Remarks

Associate the InfoCacheAttribute with TInfo to configure the info cache. If not configured, default settings with UseWeakReferences set to true are used.

Methods

Delete(TInfo)

Deletes the info object from the underlying data store.

public virtual void Delete(TInfo info)

Parameters

info TInfo

Info object to be deleted.

Exceptions

ArgumentNullException

Thrown when info is null.

DeleteAsync(TInfo, CancellationToken?)

Asynchronously deletes the info object from the underlying data store.

public virtual Task DeleteAsync(TInfo info, CancellationToken? cancellationToken = null)

Parameters

info TInfo

Info object to be deleted.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task

Remarks

For compatibility reasons, the base implementation calls the synchronous Delete(TInfo).

For info objects without an explicitly generated provider, the system-provided implementation overrides this method and invokes the DeleteInfoAsync(TInfo, CancellationToken) base method. Custom code with explicit provider implementation can opt in to the asynchronous execution by overriding this member.

Exceptions

ArgumentNullException

Thrown when info is null.

Get()

Gets the object query for TInfo retrieval.

public virtual ObjectQuery<TInfo> Get()

Returns

ObjectQuery<TInfo>

Returns ObjectQuery<TObject> for TInfo retrieval.

Get(Guid)

Gets an instance of info object based on its GUID.

public virtual TInfo Get(Guid guid)

Parameters

guid Guid

GUID of the info object to look for.

Returns

TInfo

Returns an instance of TInfo corresponding to guid or null.

Exceptions

NotSupportedException

Thrown when TInfo does not have the GUID column.

Get(int)

Gets an instance of info object based on its ID.

public virtual TInfo Get(int id)

Parameters

id int

ID of the info object to look for.

Returns

TInfo

Returns an instance of TInfo corresponding to id or null.

Exceptions

NotSupportedException

Thrown when TInfo does not have the ID column.

Get(string)

Gets an instance of info object based on its code name.

public virtual TInfo Get(string name)

Parameters

name string

Code name of the info object to look for.

Returns

TInfo

Returns an instance of TInfo corresponding to name or null.

Exceptions

NotSupportedException

Thrown when TInfo does not have the code name column.

GetAsync(Guid, CancellationToken?)

Asynchronously gets an instance of info object based on its GUID.

public virtual Task<TInfo> GetAsync(Guid guid, CancellationToken? cancellationToken = null)

Parameters

guid Guid

GUID of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<TInfo>

Returns a task returning either an instance of TInfo corresponding to guid or null.

Exceptions

NotSupportedException

Thrown when TInfo does not have the GUID column.

GetAsync(int, CancellationToken?)

Asynchronously gets an instance of info object based on its ID.

public virtual Task<TInfo> GetAsync(int id, CancellationToken? cancellationToken = null)

Parameters

id int

ID of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<TInfo>

Returns a task returning either an instance of TInfo corresponding to id or null.

Exceptions

NotSupportedException

Thrown when TInfo does not have the ID column.

GetAsync(string, CancellationToken?)

Asynchronously gets an instance of info object based on its code name.

public virtual Task<TInfo> GetAsync(string name, CancellationToken? cancellationToken = null)

Parameters

name string

Code name of the info object to look for.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<TInfo>

Returns a task returning either an instance of TInfo corresponding to name or null.

Exceptions

NotSupportedException

Thrown when TInfo does not have the code name column.

GetObjectQueryInternal()

Gets the object query for the provider

protected override ObjectQuery<TInfo> GetObjectQueryInternal()

Returns

ObjectQuery<TInfo>

Set(TInfo)

Inserts or updates the info object in the underlying data store.

public virtual void Set(TInfo info)

Parameters

info TInfo

Info object to be inserted or updated.

Exceptions

ArgumentNullException

Thrown when info is null.

SetAsync(TInfo, CancellationToken?)

Asynchronously inserts or updates the info object in the underlying data store.

public virtual Task SetAsync(TInfo info, CancellationToken? cancellationToken = null)

Parameters

info TInfo

Info object to be inserted or updated.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task

Remarks

For compatibility reasons, the base implementation calls the synchronous Set(TInfo).

For info objects without an explicitly generated provider, the system-provided implementation overrides this method and invokes the SetInfoAsync(TInfo, CancellationToken) base method. Custom code with explicit provider implementation can opt in to the asynchronous execution by overriding this member.

Exceptions

ArgumentNullException

Thrown when info is null.