public interface

BatchLicenseAudit

com.microstrategy.web.objects.admin.licensing.BatchLicenseAudit

Class Overview

The BatchLicenseAudit interface allows the user to retrieve results of the audit in an incremental manner. The batch audit is identified by its ID – when the newBatchAudit(WebUserEntity, int) method is called, a new audit job is started on the Intelligence Server, and the first set of results from the job are retrieved (using the blockCount given). From that point on, the audit will continue to run on the Intelligence Server, and the results can be retrieved when needed in chunks.

Summary

Public Methods
abstract int getAuditID()
Return the batch audit handle ID.
abstract int getBlockCount()
Returns the block count to incrementally audit users.
abstract BatchAuditResults getResults(int blockBegin)
Returns the result of a batch auditing operation.
abstract boolean isEndOfAudit()
Returns whether it is the end of user license auditing.
abstract void setBlockCount(int count)
Sets the block count to incrementally audit users.

Public Methods

public abstract int getAuditID ()

Return the batch audit handle ID.

Returns
  • a unique identifier for a batch audit.

public abstract int getBlockCount ()

Returns the block count to incrementally audit users.

Returns
  • the block count.

public abstract BatchAuditResults getResults (int blockBegin)

Returns the result of a batch auditing operation.

Parameters
blockBegin the start point to perform batch audit.
Returns
  • the batch auditing result.
Throws
WebObjectsException

public abstract boolean isEndOfAudit ()

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 void setBlockCount (int count)

Sets the block count to incrementally audit users.

Parameters
count the block count.