Interface BatchLicenseAudit
-
public interface BatchLicenseAudit
TheBatchLicenseAudit
interface allows the user to retrieve results of the audit in an incremental manner. The batch audit is identified by its ID when theLicenseSource.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.- Since:
- MicroStrategy Web 8.0.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAuditID()
Return the batch audit handle ID.int
getBlockCount()
Returns the block count to incrementally audit users.BatchAuditResults
getResults(int blockBegin)
Returns the result of a batch auditing operation.boolean
isEndOfAudit()
Returns whether it is the end of user license auditing.void
setBlockCount(int count)
Sets the block count to incrementally audit users.
-
-
-
Method Detail
-
setBlockCount
void setBlockCount(int count)
Sets the block count to incrementally audit users.- Parameters:
count
- the block count.
-
getBlockCount
int getBlockCount()
Returns the block count to incrementally audit users.- Returns:
- the block count.
-
getAuditID
int getAuditID()
Return the batch audit handle ID.- Returns:
- a unique identifier for a batch audit.
-
getResults
BatchAuditResults getResults(int blockBegin) throws WebObjectsException
Returns the result of a batch auditing operation.- Parameters:
blockBegin
- the start point to perform batch audit.- Returns:
- the batch auditing result.
- Throws:
WebObjectsException
-
isEndOfAudit
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.
-
-