MonitorResults

The MonitorResults interface represents the results of retrieving monitoring information. It has four derived interfaces: JobResults, UserConnectionResults, DBConnectionResults, and CacheResults. The derived interfaces simply add a type-specific get method; all other functionality is common across all monitor types.

The results can be split into two parts: a count of items, optionally grouped by the value of one or more fields, and a detailed list of items. This is the interface which gives out both sets of data.

The following methods are exposed on the MonitorResults interface:

• getCount()

  Returns the total count of items returned in the browsing request.  

• getCountSummary():CountSummary

  Returns the CountSummary interface containing summary count information.

  If the count information is not specified in the MonitorSource, then the count summary has only an overall count, rather than a count broken down by category.

• getLevel()

  Returns the level of data asked for in the request to get results. This determines the monitoring information that is populated on each object returned. This value is obtained from the EnumDSSXMLLevelFlags enumeration. 

• elements()

  Returns a java.util.Enumeration containing the individual items in the collection.

  If the level flag is count only, this method will throw an exception.

• get()

  Returns the item in the collection at the given index. The get method is on each derived interface of MonitorResults, because it returns a type-specific object from the results.

  If only the count flag was set, this method will throw an exception because detailed data is not available.