@com.fasterxml.jackson.annotation.JsonTypeName(value: scanResponse) @com.fasterxml.jackson.annotation.JsonTypeInfo(include: JsonTypeInfo.As.WRAPPER_OBJECT, use: JsonTypeInfo.Id.NAME) @groovy.transform.ToString(includeNames: true, includePackage: false) class ScanResponse extends java.lang.Object implements ScanResponseInterface
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 |
|---|---|
private java.lang.String |
barcodeThe original barcode input string. |
private LSN |
lsnThe LSN the scan resolved to. |
private org.simplemes.eframe.exception.MessageHolder |
messageHolderMessages from the actions performed by the scan service logic (e.g. from the Start, Complete, etc). |
private int |
operationSequenceThe operation sequence to process. |
private Order |
orderThe order the scan resolved to. |
private java.util.Map |
parsedBarcodeThe parsed barcode content. |
private boolean |
resolvedSet to true if the barcode was resolved successfully. |
private java.util.List |
scanActionsThe recommended actions the client will need to take to respond to the scan. |
private java.util.List<UndoActionInterface> |
undoActionsThe undo action(s) needed to undo the previous user action. |
| Constructor and description |
|---|
ScanResponse
(ScanRequestInterface scanRequest)The copy constructor to use with a generic ScanRequest. |
ScanResponse
() |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
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.
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 Maps in this list use the action's properties as the key. This allows easier conversion to JSON for the client.
The undo action(s) needed to undo the previous user action.
The copy constructor to use with a generic ScanRequest. Copies the common fields to the new object.
scanRequest - The scan request to create the response from.Groovy Documentation