Show / Hide Table of Contents

Class StatusMonitor

Definition of all properties for a status monitor

Carrier object for StatusMonitor. Services for the StatusMonitor Carrier is available from the Saint Agent.
Inheritance
object
StatusMonitor
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class StatusMonitor : Carrier

Constructors

StatusMonitor()

Default constructor

Declaration
public StatusMonitor()
See Also
ISaintAgent

Properties

DefaultTask

"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"

Declaration
[DataMember]
public virtual int DefaultTask { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

DefaultTaskText

Default task text for this status

Declaration
[DataMember]
public virtual string DefaultTaskText { get; set; }
Property Value
Type Description
string
See Also
ISaintAgent

Deleted

Deleted flag, 1 if this record is deleted (never from the database)

Declaration
[DataMember]
public virtual bool Deleted { get; set; }
Property Value
Type Description
bool
See Also
ISaintAgent

Description

Description of the status monitor

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also
ISaintAgent

GenerationStart

When was the last regeneration started

Declaration
[DataMember]
public virtual DateTime GenerationStart { get; set; }
Property Value
Type Description
DateTime
See Also
ISaintAgent

IsVisual

Should the status be visualized (active) in the client

Declaration
[DataMember]
public virtual bool IsVisual { get; set; }
Property Value
Type Description
bool
See Also
ISaintAgent

LastGenerated

When was this status last generated (i.e., statusValue rows created)

Declaration
[DataMember]
public virtual DateTime LastGenerated { get; set; }
Property Value
Type Description
DateTime
See Also
ISaintAgent

Name

Name of status monitor

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
ISaintAgent

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

Declaration
[DataMember]
public virtual bool NeedsUpdate { get; set; }
Property Value
Type Description
bool
See Also
ISaintAgent

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

Declaration
[DataMember]
public virtual int NumMatches { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

NumNeedUpdate

Number of targets that had this status, but have their needsUpdate bit set due to some change

Declaration
[DataMember]
public virtual int NumNeedUpdate { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

OwnerTable

Id of table that owns the status monitor

Declaration
[DataMember]
public virtual int OwnerTable { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

PictureId

Id of BinaryObject row that contains image for status monitor

Declaration
[DataMember]
public virtual int PictureId { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

Rank

Priority rank, in case more than one status is signalled. Lowest wins

Declaration
[DataMember]
public virtual int Rank { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

StatusMonitorId

Primary key

Declaration
[DataMember]
public virtual int StatusMonitorId { get; set; }
Property Value
Type Description
int
See Also
ISaintAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
ISaintAgent

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)

Returns
Type Description
string

The carrier contents.

See Also
ISaintAgent

See Also

ISaintAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top