Class NSStatusMonitor
Definition of all properties for a status monitor.
Constructors
NSStatusMonitor()
Initializes a new instance of the NSStatusMonitor class.
Declaration
NSStatusMonitorMethods
GetDefaultTask()
Declaration
Integer GetDefaultTask()Examples
NSStatusMonitor thing;
Integer defaultTask = thing.GetDefaultTask();Returns
| Type | Description |
| Integer | Default task type for this status. |
GetDefaultTaskText()
Declaration
String GetDefaultTaskText()Examples
NSStatusMonitor thing;
String defaultTaskText = thing.GetDefaultTaskText();Returns
| Type | Description |
| String | Default task text for this status. |
GetDeleted()
Declaration
Bool GetDeleted()Examples
NSStatusMonitor thing;
Bool deleted = thing.GetDeleted();Returns
| Type | Description |
| Bool | Deleted flag, 1 if this record is deleted (never from the database). |
GetDescription()
Declaration
String GetDescription()Examples
NSStatusMonitor thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | Description of the status monitor. |
GetGenerationStart()
Declaration
DateTime GetGenerationStart()Examples
NSStatusMonitor thing;
DateTime generationStart = thing.GetGenerationStart();Returns
| Type | Description |
| DateTime | When was the last regeneration started. |
GetIsVisual()
Declaration
Bool GetIsVisual()Examples
NSStatusMonitor thing;
Bool isVisual = thing.GetIsVisual();Returns
| Type | Description |
| Bool | Should the status be visualized (active) in the client. |
GetLastGenerated()
Declaration
DateTime GetLastGenerated()Examples
NSStatusMonitor thing;
DateTime lastGenerated = thing.GetLastGenerated();Returns
| Type | Description |
| DateTime | When was this status last generated (i.e., statusValue rows created). |
GetName()
Declaration
String GetName()Examples
NSStatusMonitor thing;
String name = thing.GetName();Returns
| Type | Description |
| String | Name of status monitor. |
GetNeedsUpdate()
Declaration
Bool GetNeedsUpdate()Examples
NSStatusMonitor thing;
Bool needsUpdate = thing.GetNeedsUpdate();Returns
| Type | Description |
| 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. |
GetNumMatches()
Declaration
Integer GetNumMatches()Examples
NSStatusMonitor thing;
Integer numMatches = thing.GetNumMatches();Returns
| Type | Description |
| 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 |
GetNumNeedUpdate()
Declaration
Integer GetNumNeedUpdate()Examples
NSStatusMonitor thing;
Integer numNeedUpdate = thing.GetNumNeedUpdate();Returns
| Type | Description |
| Integer | Number of targets that had this status, but have their needsUpdate bit set due to some change. |
GetOwnerTable()
Declaration
Integer GetOwnerTable()Examples
NSStatusMonitor thing;
Integer ownerTable = thing.GetOwnerTable();Returns
| Type | Description |
| Integer | ID of table that owns the status monitor. |
GetPictureId()
Declaration
Integer GetPictureId()Examples
NSStatusMonitor thing;
Integer pictureId = thing.GetPictureId();Returns
| Type | Description |
| Integer | ID of BinaryObject row that contains image for status monitor. |
GetRank()
Declaration
Integer GetRank()Examples
NSStatusMonitor thing;
Integer rank = thing.GetRank();Returns
| Type | Description |
| Integer | Priority rank, in case more than one status is signalled. Lowest wins. |
GetStatusMonitorId()
Declaration
Integer GetStatusMonitorId()Examples
NSStatusMonitor thing;
Integer statusMonitorId = thing.GetStatusMonitorId();Returns
| Type | Description |
| Integer | Primary key. |
SetDefaultTask(Integer)
Declaration
Void SetDefaultTask(Integer defaultTask)Examples
NSStatusMonitor thing;
Integer defaultTask;
thing.SetDefaultTask(defaultTask);Parameters
| Type | Name | Description |
| Integer | defaultTask | Default task type for this status. |
Returns
| Type | Description |
| Void |
SetDefaultTaskText(String)
Declaration
Void SetDefaultTaskText(String defaultTaskText)Examples
NSStatusMonitor thing;
String defaultTaskText;
thing.SetDefaultTaskText(defaultTaskText);Parameters
| Type | Name | Description |
| String | defaultTaskText | Default task text for this status. |
Returns
| Type | Description |
| Void |
SetDeleted(Bool)
Declaration
Void SetDeleted(Bool deleted)Examples
NSStatusMonitor thing;
Bool deleted;
thing.SetDeleted(deleted);Parameters
| Type | Name | Description |
| Bool | deleted | Deleted flag, 1 if this record is deleted (never from the database). |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSStatusMonitor thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | Description of the status monitor. |
Returns
| Type | Description |
| Void |
SetGenerationStart(DateTime)
Declaration
Void SetGenerationStart(DateTime generationStart)Examples
NSStatusMonitor thing;
DateTime generationStart;
thing.SetGenerationStart(generationStart);Parameters
| Type | Name | Description |
| DateTime | generationStart | When was the last regeneration started. |
Returns
| Type | Description |
| Void |
SetIsVisual(Bool)
Declaration
Void SetIsVisual(Bool isVisual)Examples
NSStatusMonitor thing;
Bool isVisual;
thing.SetIsVisual(isVisual);Parameters
| Type | Name | Description |
| Bool | isVisual | Should the status be visualized (active) in the client. |
Returns
| Type | Description |
| Void |
SetLastGenerated(DateTime)
Declaration
Void SetLastGenerated(DateTime lastGenerated)Examples
NSStatusMonitor thing;
DateTime lastGenerated;
thing.SetLastGenerated(lastGenerated);Parameters
| Type | Name | Description |
| DateTime | lastGenerated | When was this status last generated (i.e., statusValue rows created). |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSStatusMonitor thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | Name of status monitor. |
Returns
| Type | Description |
| Void |
SetNeedsUpdate(Bool)
Declaration
Void SetNeedsUpdate(Bool needsUpdate)Examples
NSStatusMonitor thing;
Bool needsUpdate;
thing.SetNeedsUpdate(needsUpdate);Parameters
| Type | Name | Description |
| Bool | needsUpdate | 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. |
Returns
| Type | Description |
| Void |
SetNumMatches(Integer)
Declaration
Void SetNumMatches(Integer numMatches)Examples
NSStatusMonitor thing;
Integer numMatches;
thing.SetNumMatches(numMatches);Parameters
| Type | Name | Description |
| Integer | numMatches | 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 |
Returns
| Type | Description |
| Void |
SetNumNeedUpdate(Integer)
Declaration
Void SetNumNeedUpdate(Integer numNeedUpdate)Examples
NSStatusMonitor thing;
Integer numNeedUpdate;
thing.SetNumNeedUpdate(numNeedUpdate);Parameters
| Type | Name | Description |
| Integer | numNeedUpdate | Number of targets that had this status, but have their needsUpdate bit set due to some change. |
Returns
| Type | Description |
| Void |
SetOwnerTable(Integer)
Declaration
Void SetOwnerTable(Integer ownerTable)Examples
NSStatusMonitor thing;
Integer ownerTable;
thing.SetOwnerTable(ownerTable);Parameters
| Type | Name | Description |
| Integer | ownerTable | ID of table that owns the status monitor. |
Returns
| Type | Description |
| Void |
SetPictureId(Integer)
Declaration
Void SetPictureId(Integer pictureId)Examples
NSStatusMonitor thing;
Integer pictureId;
thing.SetPictureId(pictureId);Parameters
| Type | Name | Description |
| Integer | pictureId | ID of BinaryObject row that contains image for status monitor. |
Returns
| Type | Description |
| Void |