NSBatchTaskInfo - SuperOffice

Contains information about one batch task.

Constructors

NSBatchTaskInfo()

NSBatchTaskInfo

Initializes a new instance of the NSBatchTaskInfo class.

Methods

GetAssociateId()

Integer GetAssociateId()

Returns: CRMScript.Global.Integer - Task owner. If it is a System task, AssociateId = 0. Example:

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

GetContext()

String GetContext()

Returns: CRMScript.Global.String - Context for the executing task. Example:

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

GetCreated()

DateTime GetCreated()

Returns: CRMScript.Global.DateTime - Task creation time. Example:

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

GetDatabaseSerialNumber()

String GetDatabaseSerialNumber()

Returns: CRMScript.Global.String - Serial number of the database the task is to run on. Example:

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

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - Description of the task. Example:

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

GetDetailsRecord()

Integer GetDetailsRecord()

Returns: CRMScript.Global.Integer - Record ID of a row in the DetailsTable containing more info about the task. Example:

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

GetDetailsTable()

Integer GetDetailsTable()

Returns: CRMScript.Global.Integer - ID of table with more information about the task. Example:

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

GetId()

Integer GetId()

Returns: CRMScript.Global.Integer - ID of the task. Example:

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

GetIsInternalTask()

Bool GetIsInternalTask()

Returns: CRMScript.Global.Bool - If true, this task will not add a trace to the database. Example:

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

GetIsSystemTask()

Bool GetIsSystemTask()

Returns: CRMScript.Global.Bool - If true, the task is not initiated by an associate. Example:

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

GetLastStarted()

DateTime GetLastStarted()

Returns: CRMScript.Global.DateTime - When was the task last started. Example:

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

GetName()

String GetName()

Returns: CRMScript.Global.String - Name of the task. Example:

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

GetParameterObject()

Map GetParameterObject()

Returns: CRMScript.Native.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. Example:

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

GetProgressDescription()

String GetProgressDescription()

Returns: CRMScript.Global.String - Descriptive text for the current stage. Example:

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

GetProgressPercent()

Integer GetProgressPercent()

Returns: CRMScript.Global.Integer - Task progress, in percent of estimated total. Example:

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

GetRequest()

String GetRequest()

Returns: CRMScript.Global.String - Maps to the request field in the batchtask table. Example:

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

GetResponse()

Maps to the response field in the batchtask table.

String GetResponse()

Returns: CRMScript.Global.String Example:

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

GetResult()

Maps to the result field in the batchtask table.

String GetResult()

Returns: CRMScript.Global.String Example:

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

GetStartCount()

Maps to the startcount field in the batchtask table.

Integer GetStartCount()

Returns: CRMScript.Global.Integer Example:

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

GetState()

BatchTaskState of the task.

Integer GetState()

Returns: CRMScript.Global.Integer Example:

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

SetAssociateId(Integer)

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

Void SetAssociateId(Integer associateId)

Returns: CRMScript.Global.Void Example:

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

SetContext(String)

Context for the executing task.

Void SetContext(String context)

Returns: CRMScript.Global.Void Example:

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

SetCreated(DateTime)

Void SetCreated(DateTime created)

Returns: CRMScript.Global.Void Example:

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

SetDatabaseSerialNumber(String)

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

Void SetDatabaseSerialNumber(String databaseSerialNumber)

Returns: CRMScript.Global.Void Example:

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

SetDescription(String)

Description of the task.

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

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

SetDetailsRecord(Integer)

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

Void SetDetailsRecord(Integer detailsRecord)

Returns: CRMScript.Global.Void Example:

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

SetDetailsTable(Integer)

ID of table with more information about the task.

Void SetDetailsTable(Integer detailsTable)

Returns: CRMScript.Global.Void Example:

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

SetId(Integer)

ID of the task.

Void SetId(Integer id)

Returns: CRMScript.Global.Void Example:

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

SetIsInternalTask(Bool)

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

Void SetIsInternalTask(Bool isInternalTask)

Returns: CRMScript.Global.Void Example:

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

SetIsSystemTask(Bool)

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

Void SetIsSystemTask(Bool isSystemTask)

Returns: CRMScript.Global.Void Example:

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

SetLastStarted(DateTime)

Void SetLastStarted(DateTime lastStarted)

Returns: CRMScript.Global.Void Example:

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

SetName(String)

Name of the task.

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

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.

Void SetParameterObject(Map parameterObject)

Returns: CRMScript.Global.Void Example:

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

SetProgressDescription(String)

Descriptive text for the current stage

Void SetProgressDescription(String progressDescription)

Returns: CRMScript.Global.Void Example:

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

SetProgressPercent(Integer)

Task progress, in percent of estimated total

Void SetProgressPercent(Integer progressPercent)

Returns: CRMScript.Global.Void Example:

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

SetRequest(String)

Maps to the request field in the batchtask table.

Void SetRequest(String request)

Returns: CRMScript.Global.Void Example:

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

SetResponse(String)

Maps to the response field in the batchtask table.

Void SetResponse(String response)

Returns: CRMScript.Global.Void Example:

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

SetResult(String)

Maps to the result field in the batchtask table.

Void SetResult(String result)

Returns: CRMScript.Global.Void Example:

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

SetStartCount(Integer)

Maps to the startcount field in the batchtask table.

Void SetStartCount(Integer startCount)

Returns: CRMScript.Global.Void Example:

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

SetState(Integer)

BatchTaskState of the task.

Void SetState(Integer state)

Returns: CRMScript.Global.Void

See <xref href=“CRMScript.NetServer.BatchTaskState” data-throw-if-not-resolved=“false”></xref>

Example:

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

​Constructors

​NSBatchTaskInfo()

​Methods

​GetAssociateId()

​GetContext()

​GetCreated()

​GetDatabaseSerialNumber()

​GetDescription()

​GetDetailsRecord()

​GetDetailsTable()

​GetId()

​GetIsInternalTask()

​GetIsSystemTask()

​GetLastStarted()

​GetName()

​GetParameterObject()

​GetProgressDescription()

​GetProgressPercent()

​GetRequest()

​GetResponse()

​GetResult()

​GetStartCount()

​GetState()

​SetAssociateId(Integer)

​SetContext(String)

​SetCreated(DateTime)

​SetDatabaseSerialNumber(String)

​SetDescription(String)

​SetDetailsRecord(Integer)

​SetDetailsTable(Integer)

​SetId(Integer)

​SetIsInternalTask(Bool)

​SetIsSystemTask(Bool)

​SetLastStarted(DateTime)

​SetName(String)

​SetParameterObject(Map)

​SetProgressDescription(String)

​SetProgressPercent(Integer)

​SetRequest(String)

​SetResponse(String)

​SetResult(String)

​SetStartCount(Integer)

​SetState(Integer)

Constructors

NSBatchTaskInfo()

Methods

GetAssociateId()

GetContext()

GetCreated()

GetDatabaseSerialNumber()

GetDescription()

GetDetailsRecord()

GetDetailsTable()

GetId()

GetIsInternalTask()

GetIsSystemTask()

GetLastStarted()

GetName()

GetParameterObject()

GetProgressDescription()

GetProgressPercent()

GetRequest()

GetResponse()

GetResult()

GetStartCount()

GetState()

SetAssociateId(Integer)

SetContext(String)

SetCreated(DateTime)

SetDatabaseSerialNumber(String)

SetDescription(String)

SetDetailsRecord(Integer)

SetDetailsTable(Integer)

SetId(Integer)

SetIsInternalTask(Bool)

SetIsSystemTask(Bool)

SetLastStarted(DateTime)

SetName(String)

SetParameterObject(Map)

SetProgressDescription(String)

SetProgressPercent(Integer)

SetRequest(String)

SetResponse(String)

SetResult(String)

SetStartCount(Integer)

SetState(Integer)