public interface

BatchAuditResults

com.microstrategy.web.objects.admin.licensing.BatchAuditResults

Class Overview

The BatchAuditResults interface exposes a single batch of users returned from an audit. You can use this interface to get each UserLicenseInfo object, or to get the blockBegin and blockCount settings used to retrieve this set of users. Finally, the isEndOfAudit method will tell you whether this is the last portion of data for the audit or whether more data still exists.

Summary

Public Methods
abstract Enumeration elements()
Returns an enumeratioin over all the the UserLicenseInfo objects.
abstract UserLicenseInfo get(int i)
Returns the UserLicenseInfo object at the specified position.
abstract int getBlockBegin()
Returns the block begin of the current auditing result.
abstract int getBlockCount()
Returns the block count of the current auditing result.
abstract List<ContactLicenseInfo> getContactLicenseInfos()
Returns license info of contacts
abstract boolean isComplete()
Returns whether it is the end of user license auditing.
abstract int size()
Returns the number of UserLicenseInfo objects in the result.

Public Methods

public abstract Enumeration elements ()

Returns an enumeratioin over all the the UserLicenseInfo objects.

Returns
  • an enumeratioin over all the the UserLicenseInfo objects.

public abstract UserLicenseInfo get (int i)

Returns the UserLicenseInfo object at the specified position.

Parameters
i the index to a UserLicenseInfo object.
Returns
  • the UserLicenseInfo object at the specified position.

public abstract int getBlockBegin ()

Returns the block begin of the current auditing result.

Returns
  • the block begin.

public abstract int getBlockCount ()

Returns the block count of the current auditing result.

Returns
  • the block count

public abstract List<ContactLicenseInfo> getContactLicenseInfos ()

Returns license info of contacts

Returns
  • license info of contacts.

public abstract boolean isComplete ()

Returns whether it is the end of user license auditing. If it is end of auditing, the auditing handle will be deleted automatically.

Returns
  • true if we reach the end of auditing.

public abstract int size ()

Returns the number of UserLicenseInfo objects in the result.

Returns
  • the number of UserLicenseInfo objects