Package com.microstrategy.web.objects

Interface WebMonitor

All Superinterfaces:

EnumWebPersistableState, KeyedObject, Persistable, WebDisplayUnit, WebFeatures, WebObjectInfo, WebPromptSite

All Known Subinterfaces:

WebPerformanceMonitor

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.

Since:

MicroStrategy Web 7.5.0

Field Summary

Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState

BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO

Method Summary

Modifier and Type	Method	Description
WebMonitorField	add(java.lang.String name)	Adds a WebMonitorField to the monitor with the name passed.
java.util.Enumeration	elements()	Returns an enumeration of the monitor fields.
WebMonitorField	get(int i)	Returns the WebMonitorField at the index passed.
WebMonitorField	getItemByName(java.lang.String name)	Returns the WebMonitorField with the name passed.
int	getMonitorType()	Returns the type of this monitor.
boolean	isEmpty()	Tests if there are no monitor fields.
WebMonitorField	remove(int i)	Removes the WebMonitorField at the index passed.
boolean	remove(WebMonitorField monitorField)	Removes the WebMonitorField passed.
int	size()	Returns the number of monitor fields in this monitor.

Methods inherited from interface com.microstrategy.utils.KeyedObject

_getObKey

Methods inherited from interface com.microstrategy.utils.serialization.Persistable

restoreState, restoreState, saveState, saveState, saveState, saveState

Methods inherited from interface com.microstrategy.web.objects.WebDisplayUnit

addDetails, applyVisitor, canHighlight, getChildUnits, getDisplayName, getDisplayUnitType, hasDetails, highlightUnit, highlightUnit, isHighlighted, isObjectInfo, isSelected, setDisplayName, setSelected

Methods inherited from interface com.microstrategy.web.objects.WebFeatures

isFeatureAvailable, isFeatureAvailable

Methods inherited from interface com.microstrategy.web.objects.WebObjectInfo

buildShortObjectAttributes, buildShortXML, getAbbreviation, getAccessGranted, getAncestors, getCardStatus, getCertifiedInfo, getComments, getContainerDid, getContainerType, getCreationTime, getCreationTimeStamp, getDataSources, getDescription, getExtendedType, getFactory, getFlags, getIconPath, getID, getModificationTime, getModificationTimeStamp, getName, getNonSchedulable, getOtherNameTransCount, getOwner, getParent, getPreSaveAsFlags, getProjectId, getProjectName, getPropertyFlags, getPropertySetFilter, getPropertySets, getRecommendationInfo, getSecurity, getState, getSubType, getType, getVersionID, getViewMediaSettings, getVisualizationViewMode, getXML, getXML, hasOwner, isAncestorNamedFolder, isDirty, isEmbedded, isHidden, isNew, isPopulated, populate, populate, setAbbreviation, setComments, setDataSources, setDescription, setExtendedType, setFlags, setHidden, setIconPath, setName, setNonSchedulable, setPreSaveAsFlags, setPropertyFlags

Methods inherited from interface com.microstrategy.web.objects.WebPromptSite

getPromptInstances

Method Detail

getMonitorType

int getMonitorType()

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

Returns:

the monitor type.

size

int size()

Returns the number of monitor fields in this monitor.

Returns:

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.

Returns:

The new monitor field added.

getItemByName

WebMonitorField getItemByName(java.lang.String name)
                       throws java.lang.IllegalArgumentException

Returns the WebMonitorField with the name passed.

Returns:

The monitor field corresponding to the name passed.

Throws:

java.lang.IllegalArgumentException - if there is no monitor field with the name passed.

get

WebMonitorField get(int i)

Returns the WebMonitorField at the index passed.

Returns:

The monitor field corresponding to the index passed.

remove

WebMonitorField remove(int i)

Removes the WebMonitorField at the index passed.

Returns:

The monitor field removed.

remove

boolean remove(WebMonitorField monitorField)

Removes the WebMonitorField passed.

Returns:

True if the monitor field could be removed.

isEmpty

boolean isEmpty()

Tests if there are no monitor fields.

Returns:

True if there are no monitor fields.

elements

java.util.Enumeration elements()

Returns an enumeration of the monitor fields.

Returns:

enumeration of monitor fields.