Class WrapperSessionScanStartRequest
-
- All Implemented Interfaces:
-
java.io.Serializable
public class WrapperSessionScanStartRequest implements Serializable
WrapperSessionScanStartRequest
Request to start a scanning session. Requires both scanViewConfigContentString (defining what to scan) and scanResultConfig (defining how to handle results). Optional scanViewInitializationParameters for workflow correlation.
-
-
Field Summary
Fields Modifier and Type Field Description public StringscanViewConfigContentStringpublic WrapperSessionScanResultConfigscanResultConfigpublic ScanViewInitializationParametersscanViewInitializationParameterspublic StringscanViewConfigPathpublic WrapperSessionScanStartPlatformOptionsplatformOptions
-
Constructor Summary
Constructors Constructor Description WrapperSessionScanStartRequest()
-
Method Summary
Modifier and Type Method Description StringgetScanViewConfigContentString()ScanViewConfig JSON string defining the scanner configuration. voidsetScanViewConfigContentString(String scanViewConfigContentString)ScanViewConfig JSON string defining the scanner configuration. WrapperSessionScanResultConfiggetScanResultConfig()WrapperSessionScanResultConfig Configuration for how scan results are returned and stored during a scanning session. voidsetScanResultConfig(WrapperSessionScanResultConfig scanResultConfig)WrapperSessionScanResultConfig Configuration for how scan results are returned and stored during a scanning session. ScanViewInitializationParametersgetScanViewInitializationParameters()ScanViewInitializationParameters Schema for ScanView JSON initialization parameters voidsetScanViewInitializationParameters(ScanViewInitializationParameters scanViewInitializationParameters)ScanViewInitializationParameters Schema for ScanView JSON initialization parameters StringgetScanViewConfigPath()Path relative to the assets folder used to resolve ScanViewConfig JSON files when a SegmentControl references them by filename. voidsetScanViewConfigPath(String scanViewConfigPath)Path relative to the assets folder used to resolve ScanViewConfig JSON files when a SegmentControl references them by filename. WrapperSessionScanStartPlatformOptionsgetPlatformOptions()WrapperSessionScanStartPlatformOptions Platform-specific options applied when starting a scan session. voidsetPlatformOptions(WrapperSessionScanStartPlatformOptions platformOptions)WrapperSessionScanStartPlatformOptions Platform-specific options applied when starting a scan session. StringtoString()inthashCode()booleanequals(Object other)-
-
Method Detail
-
getScanViewConfigContentString
String getScanViewConfigContentString()
ScanViewConfig JSON string defining the scanner configuration. (Required)
-
setScanViewConfigContentString
void setScanViewConfigContentString(String scanViewConfigContentString)
ScanViewConfig JSON string defining the scanner configuration. (Required)
-
getScanResultConfig
WrapperSessionScanResultConfig getScanResultConfig()
WrapperSessionScanResultConfig
Configuration for how scan results are returned and stored during a scanning session. (Required)
-
setScanResultConfig
void setScanResultConfig(WrapperSessionScanResultConfig scanResultConfig)
WrapperSessionScanResultConfig
Configuration for how scan results are returned and stored during a scanning session. (Required)
-
getScanViewInitializationParameters
ScanViewInitializationParameters getScanViewInitializationParameters()
ScanViewInitializationParameters
Schema for ScanView JSON initialization parameters
-
setScanViewInitializationParameters
void setScanViewInitializationParameters(ScanViewInitializationParameters scanViewInitializationParameters)
ScanViewInitializationParameters
Schema for ScanView JSON initialization parameters
-
getScanViewConfigPath
String getScanViewConfigPath()
Path relative to the assets folder used to resolve ScanViewConfig JSON files when a SegmentControl references them by filename.
-
setScanViewConfigPath
void setScanViewConfigPath(String scanViewConfigPath)
Path relative to the assets folder used to resolve ScanViewConfig JSON files when a SegmentControl references them by filename.
-
getPlatformOptions
WrapperSessionScanStartPlatformOptions getPlatformOptions()
WrapperSessionScanStartPlatformOptions
Platform-specific options applied when starting a scan session.
-
setPlatformOptions
void setPlatformOptions(WrapperSessionScanStartPlatformOptions platformOptions)
WrapperSessionScanStartPlatformOptions
Platform-specific options applied when starting a scan session.
-
hashCode
int hashCode()
-
-
-
-