public interface

WebMonitorField

com.microstrategy.web.objects.WebMonitorField

Class Overview

A WebMonitorField represents a field in the monitor object. It provides access to various monitor properties. Such properties can be traversed and edited.

Summary

Public Methods
abstract WebMonitorProperty add(String name, String value, int dataType)
Adds a WebMonitorProperty to the monitor field with the name, value, dataType passed.
abstract Enumeration elements()
Returns an enumeration of the monitor properties.
abstract WebMonitorProperty get(int i)
Returns the WebMonitorProperty at the index passed.
abstract WebMonitorProperty getItemByName(String propertyName)
Returns the WebMonitorProperty with the name passed.
abstract String getName()
Returns the name of this monitor field.
abstract boolean isEmpty()
Tests if there are no monitor properties.
abstract WebMonitorProperty remove(int i)
Removes the WebMonitorProperty at the index passed.
abstract boolean remove(WebMonitorProperty monitorProperty)
Removes the WebMonitorProperty passed.
abstract int size()
Returns the number of monitor properties in this monitor field.

Public Methods

public abstract WebMonitorProperty add (String name, 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.

public abstract Enumeration elements ()

Returns an enumeration of the monitor properties.

Returns
  • enumeration of monitor properties.

public abstract WebMonitorProperty get (int i)

Returns the WebMonitorProperty at the index passed.

Returns
  • The monitor property corresponding to the index passed.

public abstract WebMonitorProperty getItemByName (String propertyName)

Returns the WebMonitorProperty with the name passed.

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

public abstract String getName ()

Returns the name of this monitor field.

Returns
  • name of this monitor field.

public abstract boolean isEmpty ()

Tests if there are no monitor properties.

Returns
  • True if there are no monitor properties.

public abstract WebMonitorProperty remove (int i)

Removes the WebMonitorProperty at the index passed.

Returns
  • The monitor property removed.

public abstract boolean remove (WebMonitorProperty monitorProperty)

Removes the WebMonitorProperty passed.

Returns
  • True if the monitor property was removed successfully.

public abstract int size ()

Returns the number of monitor properties in this monitor field.

Returns
  • the number of monitor properties.