Interface MonitorSource
-
- All Known Subinterfaces:
CacheSource,DBConnectionSource,JobSource,UserConnectionSource
public interface MonitorSourceThe interfaceMonitorSourceis the entry point to the monitoring functionality.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CountSettingsgetCountSettings()Returns theCountSettingsobject, used to obtain counts of items grouped by various monitor fieldsMonitorFiltergetFilter()Returns theMonitorFilterobject, used to add some filter criteria to the request.intgetLevel()Returns the level of information the users want to monitor.MonitorSortgetSortCriteria()Returns theMonitorSortobject, used to control the sort order of the results.intgetType()Returns the sub type of the currentMonitorSource.voidreset()Clears the count settings, max count, filter, and sort criteria.voidsetLevel(int level)Sets the level of information the users want to monitor.
-
-
-
Method Detail
-
getCountSettings
CountSettings getCountSettings()
Returns theCountSettingsobject, used to obtain counts of items grouped by various monitor fields- Returns:
- a
CountSettingsobject.
-
getFilter
MonitorFilter getFilter()
Returns theMonitorFilterobject, used to add some filter criteria to the request.- Returns:
- the
MonitorFilterobject
-
getSortCriteria
MonitorSort getSortCriteria()
Returns theMonitorSortobject, used to control the sort order of the results.- Returns:
- the
MonitorSortobject
-
getLevel
int getLevel()
Returns the level of information the users want to monitor. A value fromEnumDSSXMLLevelFlags- Returns:
- the level of information the users want to monitor.
-
setLevel
void setLevel(int level)
Sets the level of information the users want to monitor. A value fromEnumDSSXMLLevelFlags- Parameters:
level- the level of information the users want to monitor.
-
reset
void reset()
Clears the count settings, max count, filter, and sort criteria.
-
getType
int getType()
Returns the sub type of the currentMonitorSource. The type comes fromEnumWebMonitorType.- Returns:
- the sub type of the
MonitorSource.
-
-