MonitorSource

The MonitorSource interface is the entry point to the monitoring functionality. Below is a list of the methods on this interface and what they do:

• setMaxCount()

• getMaxCount()

  Sets and returns the maximum count for a monitor data retrieval. By default, the value is –1, meaning no maximum. This value governs the maximum number of items returned from a getJobs, getUserConnections, or getDBConnections call. If the actual number of items is larger than this value, then the additional items are removed from the list.  

• getCountSettings():CountSettings 

  Returns the CountSettings interface, which can be used to allow the getJobs, getUserConnections, or getDBConnections call to obtain counts of items grouped by various monitor fields. For example, this interface can be used to specify a count that is broken down by project name, and then further broken down by the job priority. See the CountSettings interface for more information.  

• getFilter():MonitorFilter

  Returns the MonitorFilter interface, which can be used to add filter criteria to the request.  

• getSortCriteria():MonitorSort

  Returns the MonitorSort interface, which can be used to control the sort order of the results.  

• setLevel()

• getLevel()

  Sets and returns the level of information returned from the back-end when one of the retrieval methods is called. The values come from the EnumDSSXMLLevelFlags enumeration. The default value is EnumDSSXMLLevelFlags.DssXmlBrowsingLevel.  

• reset()

  Clears the count settings, maximum count, and filter and sort criteria. Call this method when reusing the source interface for multiple calls.  

• getType()

  Returns the type of the monitoring derived interface. There are four monitoring source derived interface types, which are described in EnumWebMonitorType.