public interface

WebMonitor

implements Persistable WebObjectInfo
com.microstrategy.web.objects.WebMonitor
Known Indirect Subclasses

Class Overview

A WebMonitor object corresponds to the monitor object in metadata. It is a configuration object for IServer monitoring. WebMonitor is also a first class object and is persistable. A WebMonitor can correspond to one of the different monitor types e.g.Performance Monitor. A WebMonitor can contain a list of monitor fields (represented by WebMonitorField each of which is a collection of monitor properties (represented by WebMonitorProperty. A WebMonitor can be edited. Thus, new monitor objects can be created and saved in the metadata. Similarly, existing monitor objects can be edited and saved back to metadata. The operations to save edited (or newly created) monitors are exposed through WebObjectSource.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebMonitorField add(String name)
Adds a WebMonitorField to the monitor with the name passed.
abstract Enumeration elements()
Returns an enumeration of the monitor fields.
abstract WebMonitorField get(int i)
Returns the WebMonitorField at the index passed.
abstract WebMonitorField getItemByName(String name)
Returns the WebMonitorField with the name passed.
abstract int getMonitorType()
Returns the type of this monitor.
abstract boolean isEmpty()
Tests if there are no monitor fields.
abstract WebMonitorField remove(int i)
Removes the WebMonitorField at the index passed.
abstract boolean remove(WebMonitorField monitorField)
Removes the WebMonitorField passed.
abstract int size()
Returns the number of monitor fields in this monitor.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Public Methods

public abstract WebMonitorField add (String name)

Adds a WebMonitorField to the monitor with the name passed. If a monitor field exists with the name passed, it will be overwritten.

Returns
  • The new monitor field added.

public abstract Enumeration elements ()

Returns an enumeration of the monitor fields.

Returns
  • enumeration of monitor fields.

public abstract WebMonitorField get (int i)

Returns the WebMonitorField at the index passed.

Returns
  • The monitor field corresponding to the index passed.

public abstract WebMonitorField getItemByName (String name)

Returns the WebMonitorField with the name passed.

Returns
  • The monitor field corresponding to the name passed.
Throws
IllegalArgumentException if there is no monitor field with the name passed.

public abstract int getMonitorType ()

Returns the type of this monitor. The returned value should be one from the Enumeration EnumDSSXMLMonitorType.

Returns
  • the monitor type.

public abstract boolean isEmpty ()

Tests if there are no monitor fields.

Returns
  • True if there are no monitor fields.

public abstract WebMonitorField remove (int i)

Removes the WebMonitorField at the index passed.

Returns
  • The monitor field removed.

public abstract boolean remove (WebMonitorField monitorField)

Removes the WebMonitorField passed.

Returns
  • True if the monitor field could be removed.

public abstract int size ()

Returns the number of monitor fields in this monitor.

Returns
  • the number of monitor fields.