Interface IBatchTask
Plug-in interface for tasks.
Namespace: SuperOffice.CRM.BatchProcessing
Assembly: SoBatchProcessing.dll
Syntax
public interface IBatchTask
Methods
EndTask()
End the currently executing task.
Declaration
void EndTask()
GetTaskInfo()
Get current information about the task.
Declaration
BatchTaskInfo GetTaskInfo()
Returns
Type | Description |
---|---|
BatchTaskInfo | Task info object with id, name, owner, state, result values |
StartTask(BatchTaskInfo, string, BatchTaskStatusChanged)
Start a new task based on a task descriptiong include name
Declaration
BatchTaskInfo StartTask(BatchTaskInfo batchTaskInfo, string context, BatchTaskStatusChanged onBatchTaskStatusChanged)
Parameters
Type | Name | Description |
---|---|---|
BatchTaskInfo | batchTaskInfo | Id, Name and state of the task. |
string | context | Context for the task. |
BatchTaskStatusChanged | onBatchTaskStatusChanged | Callback for status changes of the task. |
Returns
Type | Description |
---|---|
BatchTaskInfo | Task info object with id, name, owner, state, result values |
StartTask(int, string, string, BatchTaskStatusChanged)
Start a new task with a given id based on a task name
Declaration
BatchTaskInfo StartTask(int id, string name, string context, BatchTaskStatusChanged onBatchTaskStatusChanged)
Parameters
Type | Name | Description |
---|---|---|
int | id | Id assigned by the system for the task. |
string | name | Name of the task. |
string | context | Context for the task. |
BatchTaskStatusChanged | onBatchTaskStatusChanged | Callback for status changes of the task. |
Returns
Type | Description |
---|---|
BatchTaskInfo | Task info object with id, name, owner, state, result values |