Interface WebMonitorField


  • public interface WebMonitorField
    A WebMonitorField represents a field in the monitor object. It provides access to various monitor properties. Such properties can be traversed and edited.
    Since:
    MicroStrategy Web 7.5.0
    • Method Detail

      • add

        WebMonitorProperty add​(java.lang.String name,
                               java.lang.String value,
                               int dataType)
        Adds a WebMonitorProperty to the monitor field with the name, value, dataType passed. If a monitor property exists with the name passed, it will be overwritten. The dataType should be a value from the Enumeration EnumDSSXMLDataType.
        Returns:
        The new monitor property added.
      • getItemByName

        WebMonitorProperty getItemByName​(java.lang.String propertyName)
                                  throws java.lang.IllegalArgumentException
        Returns the WebMonitorProperty with the name passed.
        Returns:
        The monitor property corresponding to the name passed.
        Throws:
        java.lang.IllegalArgumentException - if there is no monitor property with the name passed.
      • size

        int size()
        Returns the number of monitor properties in this monitor field.
        Returns:
        the number of monitor properties.
      • isEmpty

        boolean isEmpty()
        Tests if there are no monitor properties.
        Returns:
        True if there are no monitor properties.
      • elements

        java.util.Enumeration elements()
        Returns an enumeration of the monitor properties.
        Returns:
        enumeration of monitor properties.
      • getName

        java.lang.String getName()
        Returns the name of this monitor field.
        Returns:
        name of this monitor field.