CountSettings

The CountSettings interface is a collection of field IDs, which specify the field to be sorted upon. The method takes a value from the enumerations EnumDSSXMLJobInfo for jobs, EnumDSSXMLDBConnectionInfo for database connections, or EnumDSSXMLUserConnectionInfo for user connections. Items can be added to the collection one-by-one using the add method, or added and removed all at once using the set and clear methods.

For example, if this collection includes the project name field and the login name field and a getJobs call is made, the count returned from the back-end would contain the count of jobs for each project, and then— for each project— the count of the jobs per login.

The actual count that this interface specifies can be obtained from the MonitorResults object, which is a result of triggering the data retrieval call on MonitorSource.

The CountSettings interface has the following methods:

• add()

  Adds a single level to the end of the count criteria. If the item is already in the collection, it is removed from its existing place in the collection and placed at the end. 

• get()

  Returns the item in the collection at the given 0-based index. 

• set()

  Takes an array of integers and sets the collection equal to the given values. 

• getAll()

  Returns the complete list of items in the collection, as an array of integers. 

• size()

  Returns the number of items in the collection. 

• clear ()

  Clears all criteria from the collection.