interface ScanResponseInterface extends org.simplemes.eframe.web.undo.UndoableInterface
The response for the scan() method. This scan resolution is typically handled by the ScanService. This POGO is returned after the scan has been evaluated.
| Type | Name and description |
|---|---|
java.lang.String |
barcode |
LSN |
lsn |
int |
operationSequence |
Order |
order |
java.util.Map |
parsedBarcode |
| Constructor and description |
|---|
ScanResponseInterface
() |
| Type Params | Return Type | Name and description |
|---|---|---|
|
java.lang.String |
getBarcode()The original barcode input string. |
|
LSN |
getLsn()The LSN the scan resolved to. |
|
org.simplemes.eframe.exception.MessageHolder |
getMessageHolder()Messages from the actions performed by the scan service logic (e.g. from the Start, Complete, etc). |
|
int |
getOperationSequence()The operation sequence to process. |
|
Order |
getOrder()The order the scan resolved to. |
|
java.util.Map |
getParsedBarcode()Returns the parsed barcode content. |
|
boolean |
getResolved()Set to true if the barcode was resolved successfully. |
|
java.util.List<ScanActionInterface> |
getScanActions()The recommended actions the client will need to take to respond to the scan. |
|
void |
setBarcode(java.lang.String barcode)The original barcode input string. |
|
void |
setLsn(LSN lsn)The LSN the scan resolved to. |
|
void |
setOperationSequence(int operationSequence)The operation sequence to process. |
|
void |
setOrder(Order order)The order the scan resolved to. |
|
void |
setParsedBarcode(java.util.Map map)Sets the parsed barcode content. |
|
void |
setResolved(boolean resolved)Set to true if the barcode was resolved successfully. |
| Methods inherited from class | Name |
|---|---|
interface org.simplemes.eframe.web.undo.UndoableInterface |
org.simplemes.eframe.web.undo.UndoableInterface#getUndoActions() |
The original barcode input string.
The LSN the scan resolved to.
Messages from the actions performed by the scan service logic (e.g. from the Start, Complete, etc).
The operation sequence to process. If not provided, then the ResolveService may find the correct operation. Only needed when the order/LSN uses a routing.
The order the scan resolved to.
Returns the parsed barcode content. This is a map with the key being the standardized logic name for the barcode element. For example: [BUTTON: 'START']
Set to true if the barcode was resolved successfully.
The recommended actions the client will need to take to respond to the scan. This can include button presses or Dashboard event triggering.
The original barcode input string.
The LSN the scan resolved to.
The operation sequence to process. If not provided, then the ResolveService may find the correct operation. Only needed when the order/LSN uses a routing.
The order the scan resolved to.
Sets the parsed barcode content. This is a map with the key being the standardized logic name for the barcode element. For example: [BUTTON: 'START']
map - The barcode parse map.Set to true if the barcode was resolved successfully.