Interface WebMonitor

  • All Superinterfaces:
    EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite
    All Known Subinterfaces:

    public interface WebMonitor
    extends WebObjectInfo, Persistable
    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.
    MicroStrategy Web 7.5.0
    • Method Detail

      • getMonitorType

        int getMonitorType()
        Returns the type of this monitor. The returned value should be one from the Enumeration EnumDSSXMLMonitorType.
        the monitor type.
      • size

        int size()
        Returns the number of monitor fields in this monitor.
        the number of monitor fields.
      • add

        WebMonitorField add​(java.lang.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.
        The new monitor field added.
      • getItemByName

        WebMonitorField getItemByName​(java.lang.String name)
                               throws java.lang.IllegalArgumentException
        Returns the WebMonitorField with the name passed.
        The monitor field corresponding to the name passed.
        java.lang.IllegalArgumentException - if there is no monitor field with the name passed.
      • isEmpty

        boolean isEmpty()
        Tests if there are no monitor fields.
        True if there are no monitor fields.
      • elements

        java.util.Enumeration elements()
        Returns an enumeration of the monitor fields.
        enumeration of monitor fields.