com.microstrategy.usher

Class ScannerResultEntity.Item

java.lang.Object

com.microstrategy.usher.ScannerResultEntity.Item

Enclosing class:

ScannerResultEntity

public abstract static class ScannerResultEntity.Item
extends java.lang.Object

The ScannerResultEntity.Item abstract class wraps various attributes pertaining to the result of a scan.

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATUS_BADGE_CONDITION_ERROR Unsuccessful scan due to a badge condition.
static int	STATUS_NETWORK_ERROR Unsuccessful scan due to a network error.
static int	STATUS_REPORT_SCANNED_DATA_NOT_CONFIG Unsuccessful scan due to Network Manager not configuring server to report scanned data.
static int	STATUS_SUCCESS Successful scan.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	backgroundColor() Returns a String of the background color of the scan result.
abstract int	badgeId() Returns an int of the identification number of the badge.
abstract java.lang.String	badgeName() Returns a String of the name of the badge.
abstract java.lang.String	orgIconUrl() Returns a String of the URL of the organization icon.
abstract int	status() Returns an int of the status of the scan.

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_SUCCESS

public static final int STATUS_SUCCESS

Successful scan. Value is 1.

See Also:

Constant Field Values

STATUS_BADGE_CONDITION_ERROR

public static final int STATUS_BADGE_CONDITION_ERROR

Unsuccessful scan due to a badge condition. Value is 2.

See Also:

Constant Field Values

STATUS_NETWORK_ERROR

public static final int STATUS_NETWORK_ERROR

Unsuccessful scan due to a network error. Value is 3.

See Also:

Constant Field Values

STATUS_REPORT_SCANNED_DATA_NOT_CONFIG

public static final int STATUS_REPORT_SCANNED_DATA_NOT_CONFIG

Unsuccessful scan due to Network Manager not configuring server to report scanned data. Value is 4.

See Also:

Constant Field Values

Method Detail

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

status

public abstract int status()

Returns an int of the status of the scan.

Returns:

the status of the scan. These include:

• STATUS_SUCCESS = 1
• STATUS_BADGE_CONDITION_ERROR = 2
• STATUS_NETWORK_ERROR = 3
• STATUS_REPORT_SCANNED_DATA_NOT_CONFIG = 4

badgeName

public abstract java.lang.String badgeName()

Returns a String of the name of the badge.

Returns:

the name of the badge.

backgroundColor

public abstract java.lang.String backgroundColor()

Returns a String of the background color of the scan result.

Returns:

the background color of the scan result.

orgIconUrl

@Nullable
public abstract java.lang.String orgIconUrl()

Returns a String of the URL of the organization icon. May be null.

Returns:

the URL of the organization icon.