UserConnectionResults

The UserConnectionResults interface is a derived interface of MonitorResults. In addition to the functionality of MonitorResults, it adds a type-specific get method and a method to disconnect an array of user connections.

The following methods, part of the MonitorResults functionality, are exposed on the UserConnectionResults interface:

• getCount()

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

• getCountSummary()

  Returns the CountSummary interface containing summary count information. Note that if the count information is not specified in the MonitorSource, then the count summary has only an overall count, not 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.

The following method is exposed on and specific to the UserConnectionResults interface:

• get()

  Returns the user connection object in the collection at the given index.  

• disconnect()

  Disconnects an array of user connection objects.  

If there is a failure to disconnect a user connection, this method throws a MonitorManipulationException. If there is a fatal error preventing this operation, such as a network error or server crash, this method throws a WebObjectsAdminException.