Interface IBatchData

Namespace: SuperOffice.CRM.BatchProcessing
Assembly: SoBatchProcessing.dll
Syntax
public interface IBatchData

Methods

DeleteBatchTasksAsync(params int[])

Delete batch tasks from the database.

Declaration
Task<bool> DeleteBatchTasksAsync(params int[] ids)
Parameters
Type Name Description
int[] ids

Array of ids to delete.
Returns
Type Description
Task<bool>

GetBatchTaskInfoAsync(int, CancellationToken)

Get information about a specified task.

Declaration
Task<BatchTaskInfo> GetBatchTaskInfoAsync(int id, CancellationToken cancellationToken)
Parameters
Type Name Description
int id

batch task id.
CancellationToken cancellationToken
Returns
Type Description
Task<BatchTaskInfo>

GetBatchTasksAsync(string, int[], BatchTaskState, DateTime, DateTime, CancellationToken)

Declaration
Task<BatchTaskInfo[]> GetBatchTasksAsync(string batchDefinitionName, int[] associateIds, BatchTaskState state, DateTime fromDate, DateTime toDate, CancellationToken cancellationToken)
Parameters
Type Name Description
string batchDefinitionName
int[] associateIds
BatchTaskState state
DateTime fromDate
DateTime toDate
CancellationToken cancellationToken
Returns
Type Description
Task<BatchTaskInfo[]>

SaveBatchTaskInfoAsync(BatchTaskInfo, StringDictionary)

Save a new BatchTaskInfo to the database a parameter object saved to BinaryObject table.

Declaration
Task<int> SaveBatchTaskInfoAsync(BatchTaskInfo batchTaskInfo, StringDictionary parameterObject)
Parameters
Type Name Description
BatchTaskInfo batchTaskInfo
StringDictionary parameterObject

A serializable object. Will be saved to BinaryObject table. The link will be set using DetailsTable and DetailsRecord in object BatchTaskInfo.
Returns
Type Description
Task<int>

SetBatchTaskInfoStateAsync(BatchTaskInfo, BatchTaskState)

Update state on a BatchTaskInfo row

Declaration
Task SetBatchTaskInfoStateAsync(BatchTaskInfo batchTaskInfo, BatchTaskState state)
Parameters
Type Name Description
BatchTaskInfo batchTaskInfo
BatchTaskState state
Returns
Type Description
Task

UpdateBatchTaskAsync(BatchTaskInfo)

Update information about a BatchTask. Only the following properties can be updated: State, Description, Response and Request

Declaration
Task<BatchTaskInfo> UpdateBatchTaskAsync(BatchTaskInfo batchTaskInfo)
Parameters
Type Name Description
BatchTaskInfo batchTaskInfo

The updated information to save.
Returns
Type Description
Task<BatchTaskInfo>

The updated BatchTaskInfo

Extension Methods