com.microstrategy.usher

Class ScannerData.Builder

java.lang.Object

com.microstrategy.usher.ScannerData.Builder

Enclosing class:

ScannerData

public abstract static class ScannerData.Builder
extends java.lang.Object

The ScannerData.Builder abstract class allows the user to create and return a ScannerData object. For example:
return ScannerData.builder()
.badgeId(87151)
.content(scannerDataContent)
.permissionGranted(true)
.permissionGrantedForever(true)
.type(scannerDataType)
.build();

Method Summary

Modifier and Type	Method and Description
abstract ScannerData.Builder	badgeId(int badgeId) Returns the ScannerData.Builder for the ScannerData.badgeId() component of the ScannerData object.
abstract ScannerData	build() Builds the ScannerData object that is used to wrap various properties related to scanned data.
abstract ScannerData.Builder	content(java.lang.String content) Returns the ScannerData.Builder for the ScannerData.content() component of the ScannerData object.
abstract ScannerData.Builder	permissionGranted(boolean permissionGranted) Returns the ScannerData.Builder for the ScannerData.permissionGranted() component of the ScannerData object.
abstract ScannerData.Builder	permissionGrantedForever(boolean permissionGrantedForever) Returns the ScannerData.Builder for the ScannerData.permissionGrantedForever() component of the ScannerData object.
abstract ScannerData.Builder	type(java.lang.String type) Returns the ScannerData.Builder for the ScannerData.type() component of the ScannerData object.

Methods inherited from class java.lang.Object

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

Method Detail

content

public abstract ScannerData.Builder content(java.lang.String content)

Returns the ScannerData.Builder for the ScannerData.content() component of the ScannerData object.

Parameters:

content - the content of the scanned data

Returns:

the ScannerData.Builder for the ScannerData.content() component of the ScannerData object.

type

public abstract ScannerData.Builder type(java.lang.String type)

Returns the ScannerData.Builder for the ScannerData.type() component of the ScannerData object.

Parameters:

type - the type of the scanned data

Returns:

the ScannerData.Builder for the ScannerData.type() component of the ScannerData object.

permissionGranted

public abstract ScannerData.Builder permissionGranted(boolean permissionGranted)

Returns the ScannerData.Builder for the ScannerData.permissionGranted() component of the ScannerData object.

Parameters:

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

Returns:

the ScannerData.Builder for the ScannerData.permissionGranted() component of the ScannerData object.

permissionGrantedForever

public abstract ScannerData.Builder permissionGrantedForever(boolean permissionGrantedForever)

Returns the ScannerData.Builder for the ScannerData.permissionGrantedForever() component of the ScannerData object.

Parameters:

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

Returns:

the ScannerData.Builder for the ScannerData.permissionGrantedForever() component of the ScannerData object.

badgeId

public abstract ScannerData.Builder badgeId(int badgeId)

Returns the ScannerData.Builder for the ScannerData.badgeId() component of the ScannerData object.

Parameters:

badgeId - the identification number of the badge

Returns:

the ScannerData.Builder for the ScannerData.badgeId() component of the ScannerData object.

build

public abstract ScannerData build()

Builds the ScannerData object that is used to wrap various properties related to scanned data.

Returns:

the ScannerData object that is used to wrap various properties related to scanned data.