com.microstrategy.usher

Class ScannerResultEntity

java.lang.Object

com.microstrategy.usher.ScannerResultEntity

public abstract class ScannerResultEntity
extends java.lang.Object

The ScannerResultEntity abstract class wraps various attributes pertaining to result of scans.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScannerResultEntity.Item The ScannerResultEntity.Item abstract class wraps various attributes pertaining to the result of a scan.

Method Summary

Modifier and Type	Method and Description
abstract boolean	allFailure() Returns a boolean that represents whether or not all the badges on a device unsuccessfully processed the scan.
abstract boolean	allSuccess() Returns a boolean that represents whether or not all the badges on a device successfully processed the scan.
abstract java.util.ArrayList<ScannerResultEntity.Item>	badgeReportScannedDataEntityList() Returns an ArrayList of ScannerResultEntity.Item objects that wrap various attributes pertaining to the result of a scan.
abstract ScannerResultEntity	withBadgeReportScannedDataEntityList(java.util.ArrayList<ScannerResultEntity.Item> badgeReportScannedDataEntityList) Constructor for a ScannerResultEntity object with the badgeReportScannedDataEntityList set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

badgeReportScannedDataEntityList

public abstract java.util.ArrayList<ScannerResultEntity.Item> badgeReportScannedDataEntityList()

Returns an ArrayList of ScannerResultEntity.Item objects that wrap various attributes pertaining to the result of a scan.

Returns:

an ArrayList of ScannerResultEntity.Item objects.

allSuccess

public abstract boolean allSuccess()

Returns a boolean that represents whether or not all the badges on a device successfully processed the scan.

Returns:

true if all the badges on a device successfully processed the scan; false otherwise.

withBadgeReportScannedDataEntityList

public abstract ScannerResultEntity withBadgeReportScannedDataEntityList(java.util.ArrayList<ScannerResultEntity.Item> badgeReportScannedDataEntityList)

Constructor for a ScannerResultEntity object with the badgeReportScannedDataEntityList set.

Parameters:

badgeReportScannedDataEntityList - See badgeReportScannedDataEntityList()

Returns:

a ScannerResultEntity object with the badgeReportScannedDataEntityList set.

allFailure

public abstract boolean allFailure()

Returns a boolean that represents whether or not all the badges on a device unsuccessfully processed the scan.

Returns:

true if all the badges on a device unsuccessfully processed the scan; false otherwise.