Table of Contents

Class WebFarmServerTaskInfoProvider

Namespace
CMS.WebFarmSync
Assembly
CMS.WebFarmSync.dll

Class providing WebFarmServerTaskInfo management.

[ProviderInterface(typeof(IWebFarmServerTaskInfoProvider))]
public class WebFarmServerTaskInfoProvider : AbstractInfoProvider<WebFarmServerTaskInfo, WebFarmServerTaskInfoProvider>, IInfoProvider, ICustomizableProvider, IBulkOperationProvider, IWebFarmProvider, IInfoValidator<WebFarmServerTaskInfo>, IInfoByIdProvider<WebFarmServerTaskInfo>, IInfoByGuidProvider<WebFarmServerTaskInfo>, IInfoByNameProvider<WebFarmServerTaskInfo>, IBulkInfoProvider<WebFarmServerTaskInfo>, IWebFarmServerTaskInfoProvider, IInfoProvider<WebFarmServerTaskInfo>
Inheritance
object
WebFarmServerTaskInfoProvider
Implements
Inherited Members
Extension Methods

Methods

Add(int, int)

Creates WebFarmServerTaskInfo binding.

[Obsolete("Create a new WebFarmServerTaskInfo with specified ServerID and TaskID and use Set(WebFarmServerTaskInfo) instead.")]
[ObsoleteSince(28, 4)]
public virtual void Add(int webFarmServerId, int webFarmTaskId)

Parameters

webFarmServerId int

Web farm server ID.

webFarmTaskId int

Web farm task ID.

DeleteInfo(WebFarmServerTaskInfo)

Deletes the object to the database.

protected override void DeleteInfo(WebFarmServerTaskInfo info)

Parameters

info WebFarmServerTaskInfo

Object to delete

Get(int, int)

Gets an instance of the WebFarmServerTaskInfo binding structure.

[Obsolete("Use Get() and parametrized ObjectQuery to get the WebFarmServerTaskInfo with specified ServerID and TaskID.")]
[ObsoleteSince(28, 4)]
public virtual WebFarmServerTaskInfo Get(int webFarmServerId, int webFarmTaskId)

Parameters

webFarmServerId int

Web farm server ID.

webFarmTaskId int

Web farm task ID.

Returns

WebFarmServerTaskInfo

Returns an instance of WebFarmServerTaskInfo corresponding to given identifiers or null.

GetAsync(int, int, CancellationToken?)

Asynchronously gets an instance of the WebFarmServerTaskInfo binding structure.

[Obsolete("Use Get() and parametrized ObjectQuery to get the WebFarmServerTaskInfo with specified ServerID and TaskID.")]
[ObsoleteSince(28, 4)]
public virtual Task<WebFarmServerTaskInfo> GetAsync(int webFarmServerId, int webFarmTaskId, CancellationToken? cancellationToken = null)

Parameters

webFarmServerId int

Web farm server ID.

webFarmTaskId int

Web farm task ID.

cancellationToken CancellationToken?

The cancellation instruction.

Returns

Task<WebFarmServerTaskInfo>

Returns a task returning either an instance of WebFarmServerTaskInfo corresponding to given identifiers or null.

Remove(int, int)

Deletes WebFarmServerTaskInfo binding.

[Obsolete("Get the WebFarmServerTaskInfo with specified ServerID and TaskID using Get() and delete the task using Delete(WebFarmServerTaskInfo).")]
[ObsoleteSince(28, 4)]
public virtual void Remove(int webFarmServerId, int webFarmTaskId)

Parameters

webFarmServerId int

Web farm server ID.

webFarmTaskId int

Web farm task ID.

Set(WebFarmServerTaskInfo)

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

public override void Set(WebFarmServerTaskInfo info)

Parameters

info WebFarmServerTaskInfo

Info object to be inserted or updated.

Exceptions

ArgumentNullException

Thrown when info is null.