NSStatusMonitor - SuperOffice

Definition of all properties for a status monitor.

Constructors

NSStatusMonitor()

NSStatusMonitor

Initializes a new instance of the NSStatusMonitor class.

Methods

GetDefaultTask()

Integer GetDefaultTask()

Returns: CRMScript.Global.Integer - Default task type for this status.

The default task text is in the text table (since it can be long), and may contain template variables

Example:

NSStatusMonitor thing;
Integer defaultTask = thing.GetDefaultTask();

GetDefaultTaskText()

String GetDefaultTaskText()

Returns: CRMScript.Global.String - Default task text for this status. Example:

NSStatusMonitor thing;
String defaultTaskText = thing.GetDefaultTaskText();

GetDeleted()

Bool GetDeleted()

Returns: CRMScript.Global.Bool - Deleted flag, 1 if this record is deleted (never from the database). Example:

NSStatusMonitor thing;
Bool deleted = thing.GetDeleted();

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - Description of the status monitor. Example:

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

GetGenerationStart()

DateTime GetGenerationStart()

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

NSStatusMonitor thing;
DateTime generationStart = thing.GetGenerationStart();

GetIsVisual()

Bool GetIsVisual()

Returns: CRMScript.Global.Bool - Should the status be visualized (active) in the client. Example:

NSStatusMonitor thing;
Bool isVisual = thing.GetIsVisual();

GetLastGenerated()

DateTime GetLastGenerated()

Returns: CRMScript.Global.DateTime - When was this status last generated (i.e., statusValue rows created). Example:

NSStatusMonitor thing;
DateTime lastGenerated = thing.GetLastGenerated();

GetName()

String GetName()

Returns: CRMScript.Global.String - Name of status monitor. Example:

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

GetNeedsUpdate()

Bool GetNeedsUpdate()

Returns: CRMScript.Global.Bool - Is the definition dirty, ie., ALL values are invalid until a recalculation; this flag is set when the status DEFINITION is changed, as opposed to the flag on StatusValue. Example:

NSStatusMonitor thing;
Bool needsUpdate = thing.GetNeedsUpdate();

GetNumMatches()

Integer GetNumMatches()

Returns: CRMScript.Global.Integer - Number of targets that have this status, this should be the number of rows in StatusValue pointing to this definition, and that have isSignalled set to 1 Example:

NSStatusMonitor thing;
Integer numMatches = thing.GetNumMatches();

GetNumNeedUpdate()

Integer GetNumNeedUpdate()

Returns: CRMScript.Global.Integer - Number of targets that had this status, but have their needsUpdate bit set due to some change. Example:

NSStatusMonitor thing;
Integer numNeedUpdate = thing.GetNumNeedUpdate();

GetOwnerTable()

Integer GetOwnerTable()

Returns: CRMScript.Global.Integer - ID of table that owns the status monitor. Example:

NSStatusMonitor thing;
Integer ownerTable = thing.GetOwnerTable();

GetPictureId()

Integer GetPictureId()

Returns: CRMScript.Global.Integer - ID of BinaryObject row that contains image for status monitor. Example:

NSStatusMonitor thing;
Integer pictureId = thing.GetPictureId();

GetRank()

Integer GetRank()

Returns: CRMScript.Global.Integer - Priority rank, in case more than one status is signalled. Lowest wins. Example:

NSStatusMonitor thing;
Integer rank = thing.GetRank();

GetStatusMonitorId()

Integer GetStatusMonitorId()

Returns: CRMScript.Global.Integer - Primary key. Example:

NSStatusMonitor thing;
Integer statusMonitorId = thing.GetStatusMonitorId();

SetDefaultTask(Integer)

Void SetDefaultTask(Integer defaultTask)

Returns: CRMScript.Global.Void

The default task text is in the text table (since it can be long), and may contain template variables

Example:

NSStatusMonitor thing;
Integer defaultTask;
thing.SetDefaultTask(defaultTask);

SetDefaultTaskText(String)

Void SetDefaultTaskText(String defaultTaskText)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
String defaultTaskText;
thing.SetDefaultTaskText(defaultTaskText);

SetDeleted(Bool)

Void SetDeleted(Bool deleted)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Bool deleted;
thing.SetDeleted(deleted);

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

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

SetGenerationStart(DateTime)

Void SetGenerationStart(DateTime generationStart)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
DateTime generationStart;
thing.SetGenerationStart(generationStart);

SetIsVisual(Bool)

Void SetIsVisual(Bool isVisual)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Bool isVisual;
thing.SetIsVisual(isVisual);

SetLastGenerated(DateTime)

Void SetLastGenerated(DateTime lastGenerated)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
DateTime lastGenerated;
thing.SetLastGenerated(lastGenerated);

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

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

SetNeedsUpdate(Bool)

Void SetNeedsUpdate(Bool needsUpdate)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Bool needsUpdate;
thing.SetNeedsUpdate(needsUpdate);

SetNumMatches(Integer)

Void SetNumMatches(Integer numMatches)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Integer numMatches;
thing.SetNumMatches(numMatches);

SetNumNeedUpdate(Integer)

Void SetNumNeedUpdate(Integer numNeedUpdate)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Integer numNeedUpdate;
thing.SetNumNeedUpdate(numNeedUpdate);

SetOwnerTable(Integer)

Void SetOwnerTable(Integer ownerTable)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Integer ownerTable;
thing.SetOwnerTable(ownerTable);

SetPictureId(Integer)

Void SetPictureId(Integer pictureId)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Integer pictureId;
thing.SetPictureId(pictureId);

SetRank(Integer)

Void SetRank(Integer rank)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Integer rank;
thing.SetRank(rank);

SetStatusMonitorId(Integer)

Void SetStatusMonitorId(Integer statusMonitorId)

Returns: CRMScript.Global.Void Example:

NSStatusMonitor thing;
Integer statusMonitorId;
thing.SetStatusMonitorId(statusMonitorId);

​Constructors

​NSStatusMonitor()

​Methods

​GetDefaultTask()

​GetDefaultTaskText()

​GetDeleted()

​GetDescription()

​GetGenerationStart()

​GetIsVisual()

​GetLastGenerated()

​GetName()

​GetNeedsUpdate()

​GetNumMatches()

​GetNumNeedUpdate()

​GetOwnerTable()

​GetPictureId()

​GetRank()

​GetStatusMonitorId()

​SetDefaultTask(Integer)

​SetDefaultTaskText(String)

​SetDeleted(Bool)

​SetDescription(String)

​SetGenerationStart(DateTime)

​SetIsVisual(Bool)

​SetLastGenerated(DateTime)

​SetName(String)

​SetNeedsUpdate(Bool)

​SetNumMatches(Integer)

​SetNumNeedUpdate(Integer)

​SetOwnerTable(Integer)

​SetPictureId(Integer)

​SetRank(Integer)

​SetStatusMonitorId(Integer)

Constructors

NSStatusMonitor()

Methods

GetDefaultTask()

GetDefaultTaskText()

GetDeleted()

GetDescription()

GetGenerationStart()

GetIsVisual()

GetLastGenerated()

GetName()

GetNeedsUpdate()

GetNumMatches()

GetNumNeedUpdate()

GetOwnerTable()

GetPictureId()

GetRank()

GetStatusMonitorId()

SetDefaultTask(Integer)

SetDefaultTaskText(String)

SetDeleted(Bool)

SetDescription(String)

SetGenerationStart(DateTime)

SetIsVisual(Bool)

SetLastGenerated(DateTime)

SetName(String)

SetNeedsUpdate(Bool)

SetNumMatches(Integer)

SetNumNeedUpdate(Integer)

SetOwnerTable(Integer)

SetPictureId(Integer)

SetRank(Integer)

SetStatusMonitorId(Integer)