Class NSBatchTaskInfo

NSBatchTaskInfo()

Initializes a new instance of the NSBatchTaskInfo class.

Declaration

NSBatchTaskInfo

GetAssociateId()

Declaration

Integer GetAssociateId()

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

Returns

GetContext()

Declaration

String GetContext()

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

Returns

GetCreated()

Declaration

DateTime GetCreated()

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

Returns

GetDatabaseSerialNumber()

Declaration

String GetDatabaseSerialNumber()

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

Returns

GetDescription()

Declaration

String GetDescription()

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

Returns

GetDetailsRecord()

Declaration

Integer GetDetailsRecord()

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

Returns

GetDetailsTable()

Declaration

Integer GetDetailsTable()

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

Returns

GetId()

Declaration

Integer GetId()

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

Returns

GetIsInternalTask()

Declaration

Bool GetIsInternalTask()

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

Returns

GetIsSystemTask()

Declaration

Bool GetIsSystemTask()

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

Returns

GetLastStarted()

Declaration

DateTime GetLastStarted()

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

Returns

GetName()

Declaration

String GetName()

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

Returns

GetParameterObject()

Declaration

Map GetParameterObject()

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

Returns

GetProgressDescription()

Declaration

String GetProgressDescription()

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

Returns

GetProgressPercent()

Declaration

Integer GetProgressPercent()

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

Returns

GetRequest()

Declaration

String GetRequest()

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

Returns

GetResponse()

Maps to the response field in the batchtask table.

Declaration

String GetResponse()

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

Returns

GetResult()

Maps to the result field in the batchtask table.

Declaration

String GetResult()

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

Returns

GetStartCount()

Maps to the startcount field in the batchtask table.

Declaration

Integer GetStartCount()

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

Returns

GetState()

BatchTaskState of the task.

Declaration

Integer GetState()

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

Returns

SetAssociateId(Integer)

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

Declaration

Void SetAssociateId(Integer associateId)

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

Parameters

Returns

SetContext(String)

Context for the executing task.

Declaration

Void SetContext(String context)

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

Parameters

Returns

SetCreated(DateTime)

Declaration

Void SetCreated(DateTime created)

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

Parameters

Returns

SetDatabaseSerialNumber(String)

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

Declaration

Void SetDatabaseSerialNumber(String databaseSerialNumber)

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

Parameters

Returns

SetDescription(String)

Description of the task.

Declaration

Void SetDescription(String description)

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

Parameters

Returns

SetDetailsRecord(Integer)

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

Declaration

Void SetDetailsRecord(Integer detailsRecord)

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

Parameters

Returns

SetDetailsTable(Integer)

ID of table with more information about the task.

Declaration

Void SetDetailsTable(Integer detailsTable)

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

Parameters

Returns

SetId(Integer)

ID of the task.

Declaration

Void SetId(Integer id)

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

Parameters

Returns

SetIsInternalTask(Bool)

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

Declaration

Void SetIsInternalTask(Bool isInternalTask)

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

Parameters

Returns

SetIsSystemTask(Bool)

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

Declaration

Void SetIsSystemTask(Bool isSystemTask)

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

Parameters

Returns

SetLastStarted(DateTime)

Declaration

Void SetLastStarted(DateTime lastStarted)

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

Parameters

Returns

SetName(String)

Name of the task.

Declaration

Void SetName(String name)

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

Parameters

Returns

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)

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

Parameters

Returns

SetProgressDescription(String)

Descriptive text for the current stage

Declaration

Void SetProgressDescription(String progressDescription)

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

Parameters

Returns

SetProgressPercent(Integer)

Task progress, in percent of estimated total

Declaration

Void SetProgressPercent(Integer progressPercent)

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

Parameters

Returns

SetRequest(String)

Maps to the request field in the batchtask table.

Declaration

Void SetRequest(String request)

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

Parameters

Returns

SetResponse(String)

Maps to the response field in the batchtask table.

Declaration

Void SetResponse(String response)

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

Parameters

Returns

SetResult(String)

Maps to the result field in the batchtask table.

Declaration

Void SetResult(String result)

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

Parameters

Returns

SetStartCount(Integer)

Maps to the startcount field in the batchtask table.

Declaration

Void SetStartCount(Integer startCount)

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

Parameters

Returns

SetState(Integer)

BatchTaskState of the task.

Declaration

Void SetState(Integer state)

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

Parameters

Returns