com.microstrategy.usher

Class ScannerData

java.lang.Object

com.microstrategy.usher.ScannerData

public abstract class ScannerData
extends java.lang.Object

The ScannerData abstract class wraps the properties related to scanned data, including type, content, and badge ID, among others.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScannerData.Builder The ScannerData.Builder abstract class allows the user to create and return a ScannerData object.

Method Summary

Modifier and Type	Method and Description
abstract int	badgeId() Returns an int of the identification number of the badge.
static ScannerData.Builder	builder() Returns the default ScannerData.Builder object for the ScannerData abstract class.
abstract java.lang.String	content() Returns a String of the content of the scanned data.
abstract boolean	permissionGranted() Returns a boolean that represents whether or not permission was granted for logical access.
abstract boolean	permissionGrantedForever() Returns a boolean that represents whether or not permission was granted for logical access for this visit and any future visits.
abstract java.lang.String	type() Returns a String of the type of the scanned data.

Methods inherited from class java.lang.Object

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

Method Detail

content

public abstract java.lang.String content()

Returns a String of the content of the scanned data.

Returns:

the content of the scanned data.

type

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

Returns a String of the type of the scanned data. May be null.

Returns:

the type of the scanned data.

permissionGranted

public abstract boolean permissionGranted()

Returns a boolean that represents whether or not permission was granted for logical access. This value is true if the user chooses "Trust Once" on the logical access confirmation.

Returns:

true if permission was granted for logical access; false otherwise.

permissionGrantedForever

public abstract boolean permissionGrantedForever()

Returns a boolean that represents whether or not permission was granted for logical access for this visit and any future visits. This value is true if the user chooses "Always Trust" on the logical access confirmation.

Returns:

true if permission was granted for logical access for this visit and any future visits; false otherwise.

badgeId

public abstract int badgeId()

Returns an int of the identification number of the badge.

Returns:

the identification number of the badge.

builder

public static ScannerData.Builder builder()

Returns the default ScannerData.Builder object for the ScannerData abstract class. badgeId() will be set to BadgeIdOrgIdEntity.INVALID_BADGE_ID, permissionGranted() will be set to false, and permissionGrantedForever() will be set to false.

Returns:

the ScannerData.Builder object for the ScannerData abstract class.