Summary: Methods | [Expand All]
public interface

Counter

com.microstrategy.web.objects.admin.monitors.Counter
Known Indirect Subclasses

Class Overview

This interface represents a Counter object.

Summary

Public Methods
abstract String getHelpMessage()
Returns the help message for the counter.
abstract String getLocalizedHelpMessage(Locale locale)
Returns localized help message.
abstract String getLocalizedName(Locale locale)
Returns the localized name of the counter
abstract String getName()
Returns the name of the counter.
abstract Instance getOwnerInstance()
Returns the Instance to which this counter belongs to.
abstract CounterData getValue()
Returns a CounterData object containing the last data value collected for this counter.
abstract CounterDataList getValues()
Returns a counter data list.
abstract boolean isLogged()
Conveys if logging is enabled for this counter.
abstract boolean isLoggedToStats()
Conveys if logging to Statistic is enabled for this counter.

Public Methods

public abstract String getHelpMessage ()

Returns the help message for the counter. This is an optional string containing additional information about the counter.

Returns
  • The help message for the counter, if one exists.

public abstract String getLocalizedHelpMessage (Locale locale)

Returns localized help message.

Parameters
locale Locale The locale to localize to.
Returns
  • String The localized help message.

public abstract String getLocalizedName (Locale locale)

Returns the localized name of the counter

Parameters
locale Locale The locale to localize to.
Returns
  • String The localized counter name.

public abstract String getName ()

Returns the name of the counter.

Returns
  • The name of the counter.

public abstract Instance getOwnerInstance ()

Returns the Instance to which this counter belongs to.

Returns
  • The instance to which this counter belongs to.

public abstract CounterData getValue ()

Returns a CounterData object containing the last data value collected for this counter. Note that the counter must be monitored in order for this to exist.

Returns
  • A CounterData object containing the last data value collected.

public abstract CounterDataList getValues ()

Returns a counter data list. The counter data list represents a snapshot of the data values history, at the time when this method is called. Thus, to get updated archived values, this method can be used periodically. The number of data values archived depends on the value of historySize set on the PerformanceMonitorManager using setHistorySize(int). Note that if the historySize is increased, each subsequent call to this method will return snapshots whose size (length of their data values archive) reflects incremental growth with each new data collection from IServer (happens at times fixed by setListRefresh(int) till the archive length equals the historySize set.

Returns
  • CounterDataList the counter data list.

public abstract boolean isLogged ()

Conveys if logging is enabled for this counter.

Returns
  • boolean True if logging is enabled for this counter.

public abstract boolean isLoggedToStats ()

Conveys if logging to Statistic is enabled for this counter.

Returns
  • boolean True if logging to Statistic is enabled for this counter.