Class NSSaintAgent

NSSaintAgent()

Administration and maintenance of SAINT counters and statuses.

Declaration

NSSaintAgent

NSSaintAgent agent;
agent.callMethod(arg1, arg2);

CreateDefaultSaintConfiguration()

Sets default values into a new NSSaintConfiguration.

Declaration

NSSaintConfiguration CreateDefaultSaintConfiguration()

NSSaintAgent agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);

Returns

CreateDefaultStatusMonitor()

Sets default values into a new NSStatusMonitor.

Declaration

NSStatusMonitor CreateDefaultStatusMonitor()

NSSaintAgent agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);

Returns

CreateDefaultStatusMonitorPeriods()

Sets default values into a new NSStatusMonitorPeriods.

Declaration

NSStatusMonitorPeriods CreateDefaultStatusMonitorPeriods()

NSSaintAgent agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);

Returns

GetSaintConfigurations()

Returns the NSStatusMonitorPeriods entity.

Declaration

NSSaintConfiguration[] GetSaintConfigurations()

NSSaintAgent agent;
NSSaintConfiguration[] res = agent.GetSaintConfigurations();

Returns

GetStatusMonitor(Integer)

Gets a single status monitor based on its identity

Declaration

NSStatusMonitor GetStatusMonitor(Integer id)

NSSaintAgent agent;
Integer id;
NSStatusMonitor res = agent.GetStatusMonitor(id);

Parameters

Returns

GetStatusMonitorPeriods()

Returns the NSStatusMonitorPeriods entity.

Declaration

NSStatusMonitorPeriods GetStatusMonitorPeriods()

NSSaintAgent agent;
NSStatusMonitorPeriods res = agent.GetStatusMonitorPeriods();

Returns

GetStatusMonitors(Integer,String)

Gets all active status monitors for a specified target

Declaration

NSStatusMonitor[] GetStatusMonitors(Integer id, String type)

NSSaintAgent agent;
Integer id;
String type;
NSStatusMonitor[] res = agent.GetStatusMonitors(id, type);

Parameters

Returns

RegenerateCounters(Bool)

Regenerates the Saint counters* this can take several minutes

Declaration

NSBatchTaskInfo RegenerateCounters(Bool runAsBatch)

NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateCounters(runAsBatch);

Parameters

Returns

RegenerateStatusMonitor(Integer)

Regenerates the given status monitor

Declaration

Void RegenerateStatusMonitor(Integer statusMonitorId)

NSSaintAgent agent;
Integer statusMonitorId;
agent.RegenerateStatusMonitor(statusMonitorId);

Parameters

Returns

RegenerateStatusMonitors(Bool)

Regenerates status monitors

Declaration

NSBatchTaskInfo RegenerateStatusMonitors(Bool runAsBatch)

NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateStatusMonitors(runAsBatch);

Parameters

Returns

SaveSaintConfiguration(NSSaintConfiguration)

Updates the existing NSSaintConfiguration or creates a new NSSaintConfiguration if the id parameter is 0.

Declaration

NSSaintConfiguration SaveSaintConfiguration(NSSaintConfiguration saintConfiguration)

NSSaint  agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);

Parameters

Returns

SaveStatusMonitor(NSStatusMonitor)

Updates the existing NSStatusMonitor or creates a new NSStatusMonitor if the id parameter is 0

Declaration

NSStatusMonitor SaveStatusMonitor(NSStatusMonitor statusMonitor)

NSSaint  agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);

Parameters

Returns

SaveStatusMonitorPeriods(NSStatusMonitorPeriods)

Updates the existing NSStatusMonitorPeriods or creates a new NSStatusMonitorPeriods if the id parameter is 0

Declaration

NSStatusMonitorPeriods SaveStatusMonitorPeriods(NSStatusMonitorPeriods statusMonitorPeriods)

NSSaint  agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);

Parameters

Returns

SetRankOnStatusMonitors(String,Integer[])

Sets rank order on status monitors

Declaration

Void SetRankOnStatusMonitors(String type, Integer[] itemsIds)

NSSaintAgent agent;
String type;
Integer[] itemsIds;
agent.SetRankOnStatusMonitors(type, itemsIds);

Parameters

Returns