Class NSBatchTaskInfo

Contains information about one batch task.

Syntax

Constructors

NSBatchTaskInfo()

Initializes a new instance of the NSBatchTaskInfo class.

Declaration

NSBatchTaskInfo

Methods

GetAssociateId()

Contains information about one batch task.

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	Task owner. If it is a System task, AssociateId = 0.

Examples

NSBatchTaskInfo thing;
Integer associateId = thing.GetAssociateId();

GetContext()

Contains information about one batch task.

Declaration

String GetContext()

Returns

Type	Description
String	Context for the executing task.

Examples

NSBatchTaskInfo thing;
String context = thing.GetContext();

GetCreated()

Contains information about one batch task.

Declaration

DateTime GetCreated()

Returns

Type	Description
DateTime	Task creation time.

Examples

NSBatchTaskInfo thing;
DateTime created = thing.GetCreated();

GetDatabaseSerialNumber()

Contains information about one batch task.

Declaration

String GetDatabaseSerialNumber()

Returns

Type	Description
String	Serial number of the database the task is to run on.

Examples

NSBatchTaskInfo thing;
String databaseSerialNumber = thing.GetDatabaseSerialNumber();

GetDescription()

Contains information about one batch task.

Declaration

String GetDescription()

Returns

Type	Description
String	Description of the task.

Examples

NSBatchTaskInfo thing;
String description = thing.GetDescription();

GetDetailsRecord()

Contains information about one batch task.

Declaration

Integer GetDetailsRecord()

Returns

Type	Description
Integer	Record ID of a row in the DetailsTable containing more info about the task.

Examples

NSBatchTaskInfo thing;
Integer detailsRecord = thing.GetDetailsRecord();

GetDetailsTable()

Contains information about one batch task.

Declaration

Integer GetDetailsTable()

Returns

Type	Description
Integer	ID of table with more information about the task.

Examples

NSBatchTaskInfo thing;
Integer detailsTable = thing.GetDetailsTable();

GetId()

Contains information about one batch task.

Declaration

Integer GetId()

Returns

Type	Description
Integer	ID of the task.

Examples

NSBatchTaskInfo thing;
Integer id = thing.GetId();

GetIsInternalTask()

Contains information about one batch task.

Declaration

Bool GetIsInternalTask()

Returns

Type	Description
Bool	If true, this task will not add a trace to the database.

Examples

NSBatchTaskInfo thing;
Bool isInternalTask = thing.GetIsInternalTask();

GetIsSystemTask()

Contains information about one batch task.

Declaration

Bool GetIsSystemTask()

Returns

Type	Description
Bool	If true, the task is not initiated by an associate.

Examples

NSBatchTaskInfo thing;
Bool isSystemTask = thing.GetIsSystemTask();

GetLastStarted()

Contains information about one batch task.

Declaration

DateTime GetLastStarted()

Returns

Type	Description
DateTime	When was the task last started.

Examples

NSBatchTaskInfo thing;
DateTime lastStarted = thing.GetLastStarted();

GetName()

Contains information about one batch task.

Declaration

String GetName()

Returns

Type	Description
String	Name of the task.

Examples

NSBatchTaskInfo thing;
String name = thing.GetName();

GetParameterObject()

Contains information about one batch task.

Declaration

Map GetParameterObject()

Returns

Type	Description
Map	ParameterObject will be serialized to a binary blob and saved in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

Examples

NSBatchTaskInfo thing;
Map parameterObject = thing.GetParameterObject();

GetProgressDescription()

Contains information about one batch task.

Declaration

String GetProgressDescription()

Returns

Type	Description
String	Descriptive text for the current stage.

Examples

NSBatchTaskInfo thing;
String progressDescription = thing.GetProgressDescription();

GetProgressPercent()

Contains information about one batch task.

Declaration

Integer GetProgressPercent()

Returns

Type	Description
Integer	Task progress, in percent of estimated total.

Examples

NSBatchTaskInfo thing;
Integer progressPercent = thing.GetProgressPercent();

GetRequest()

Contains information about one batch task.

Declaration

String GetRequest()

Returns

Type	Description
String	Maps to the request field in the batchtask table.

Examples

NSBatchTaskInfo thing;
String request = thing.GetRequest();

GetResponse()

Maps to the response field in the batchtask table.

Declaration

String GetResponse()

Returns

Type	Description
String

Examples

NSBatchTaskInfo thing;
String response = thing.GetResponse();

GetResult()

Maps to the result field in the batchtask table.

Declaration

String GetResult()

Returns

Type	Description
String

Examples

NSBatchTaskInfo thing;
String result = thing.GetResult();

GetStartCount()

Maps to the startcount field in the batchtask table.

Declaration

Integer GetStartCount()

Returns

Type	Description
Integer

Examples

NSBatchTaskInfo thing;
Integer startCount = thing.GetStartCount();

GetState()

BatchTaskState of the task.

Declaration

Integer GetState()

Returns

Type	Description
Integer

Examples

NSBatchTaskInfo thing;
Integer state = thing.GetState();

SetAssociateId(Integer)

Task owner. If it is a System task, AssociateId = 0.

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetContext(String)

Context for the executing task.

Declaration

Void SetContext(String context)

Parameters

Type	Name	Description
String	context

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String context;
thing.SetContext(context);

SetCreated(DateTime)

Contains information about one batch task.

Declaration

Void SetCreated(DateTime created)

Parameters

Type	Name	Description
DateTime	created	Task creation time.

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
DateTime created;
thing.SetCreated(created);

SetDatabaseSerialNumber(String)

Serial number of the database the task is to run on.

Declaration

Void SetDatabaseSerialNumber(String databaseSerialNumber)

Parameters

Type	Name	Description
String	databaseSerialNumber

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String databaseSerialNumber;
thing.SetDatabaseSerialNumber(databaseSerialNumber);

SetDescription(String)

Description of the task.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String description;
thing.SetDescription(description);

SetDetailsRecord(Integer)

Record ID of a row in the DetailsTable containing more info about the task.

Declaration

Void SetDetailsRecord(Integer detailsRecord)

Parameters

Type	Name	Description
Integer	detailsRecord

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Integer detailsRecord;
thing.SetDetailsRecord(detailsRecord);

SetDetailsTable(Integer)

ID of table with more information about the task.

Declaration

Void SetDetailsTable(Integer detailsTable)

Parameters

Type	Name	Description
Integer	detailsTable

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Integer detailsTable;
thing.SetDetailsTable(detailsTable);

SetId(Integer)

ID of the task.

Declaration

Void SetId(Integer id)

Parameters

Type	Name	Description
Integer	id

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Integer id;
thing.SetId(id);

SetIsInternalTask(Bool)

If IsInternalTask is true, this task will not add a trace to the database.

Declaration

Void SetIsInternalTask(Bool isInternalTask)

Parameters

Type	Name	Description
Bool	isInternalTask

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Bool isInternalTask;
thing.SetIsInternalTask(isInternalTask);

SetIsSystemTask(Bool)

If IsSystemTask is true, the task is not initiated by an associate.

Declaration

Void SetIsSystemTask(Bool isSystemTask)

Parameters

Type	Name	Description
Bool	isSystemTask

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Bool isSystemTask;
thing.SetIsSystemTask(isSystemTask);

SetLastStarted(DateTime)

Contains information about one batch task.

Declaration

Void SetLastStarted(DateTime lastStarted)

Parameters

Type	Name	Description
DateTime	lastStarted	When was the task last started.

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
DateTime lastStarted;
thing.SetLastStarted(lastStarted);

SetName(String)

Name of the task.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String name;
thing.SetName(name);

SetParameterObject(Map)

Serializes a Map to a binary blob and saves it in the BinaryObject table. The link to the BinaryObject will be set using DetailsTable and DetailsRecord.

Declaration

Void SetParameterObject(Map parameterObject)

Parameters

Type	Name	Description
Map	parameterObject

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Map parameterObject;
thing.SetParameterObject(parameterObject);

SetProgressDescription(String)

Descriptive text for the current stage

Declaration

Void SetProgressDescription(String progressDescription)

Parameters

Type	Name	Description
String	progressDescription

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String progressDescription;
thing.SetProgressDescription(progressDescription);

SetProgressPercent(Integer)

Task progress, in percent of estimated total

Declaration

Void SetProgressPercent(Integer progressPercent)

Parameters

Type	Name	Description
Integer	progressPercent

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Integer progressPercent;
thing.SetProgressPercent(progressPercent);

SetRequest(String)

Maps to the request field in the batchtask table.

Declaration

Void SetRequest(String request)

Parameters

Type	Name	Description
String	request

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String request;
thing.SetRequest(request);

SetResponse(String)

Maps to the response field in the batchtask table.

Declaration

Void SetResponse(String response)

Parameters

Type	Name	Description
String	response

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String response;
thing.SetResponse(response);

SetResult(String)

Maps to the result field in the batchtask table.

Declaration

Void SetResult(String result)

Parameters

Type	Name	Description
String	result

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
String result;
thing.SetResult(result);

SetStartCount(Integer)

Maps to the startcount field in the batchtask table.

Declaration

Void SetStartCount(Integer startCount)

Parameters

Type	Name	Description
Integer	startCount

Returns

Type	Description
Void

Examples

NSBatchTaskInfo thing;
Integer startCount;
thing.SetStartCount(startCount);

SetState(Integer)

BatchTaskState of the task.

Declaration

Void SetState(Integer state)

Parameters

Type	Name	Description
Integer	state

Returns

Type	Description
Void

Remarks

See BatchTaskState

Examples

NSBatchTaskInfo thing;
Integer state;
thing.SetState(state);