ScanService (mes-core 0.5 API)

org.simplemes.mes.system.service.ScanService

```
@groovy.util.logging.Slf4j
@groovy.lang.Singleton
class ScanService
extends java.lang.Object
```
This service provided methods to handle user barcode scans in a shop floor dashboard. It determines what was scanned and processes the scan to perform the desired action on the object scanned.
See the User Guide for details on this service.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`BARCODE_BUTTON`	The logical element name for a GUI button.
`static java.lang.String`	`EVENT_SOURCE`	The source for actions/events sent back to the client.

Properties Summary

Properties
Type	Name and description
`private OrderService`	`orderService` The order service used to find Orders/LSNs states.
`private ResolveService`	`resolveService` The resolve service used to find Orders/LSNs
`private WorkService`	`workService` The work service used to start/complete orders/LSNs.

Constructor Summary

Constructors
Constructor and description
`ScanService ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Map<java.lang.String, java.lang.String>`	`getBarcodePrefixMapping()` Returns the barcode prefix mapping list.
	`java.util.Map`	`parseScan(ScanRequestInterface scanRequest)` Attempts to parse the scanned data, looking for specific markers for specific field types (e.g. button, order, lsn, product, etc).
	`void`	`processOrder(ScanResponseInterface scanResponse)` Attempts to execute the automatic actions for an order when scanned.
	`ScanResponseInterface`	`scan(ScanRequestInterface scanRequest)` Handles the scan from the user.

Inherited Methods Summary

Inherited Methods
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()`

- Field Detail
  - public static final java.lang.String BARCODE_BUTTON
    
    The logical element name for a GUI button. This is used by internal logic for determining what to do with a scan. The barcode will contain the prefix 'BTN'.
  - public static final java.lang.String EVENT_SOURCE
    
    The source for actions/events sent back to the client.
- Property Detail
  - private OrderService orderService
    
    The order service used to find Orders/LSNs states.
  - private ResolveService resolveService
    
    The resolve service used to find Orders/LSNs
  - private WorkService workService
    
    The work service used to start/complete orders/LSNs.
- Constructor Detail
  - ScanService()
- Method Detail
  - @org.simplemes.eframe.custom.annotation.ExtensionPoint(value: GetBarcodePrefixPoint, comment: The Scan dashboard getBarcodePrefixMapping() method) java.util.Map<java.lang.String, java.lang.String> getBarcodePrefixMapping()
    
    Returns the barcode prefix mapping list. This maps a literal barcode prefix value (e.g. 'BTN') to the standard name (e.g. 'BUTTON'). The standard name is used in most parsing logic decisions (e.g. which action to perform).
    This method is designed to be extended with modules. You may modify the defaultBarcodePrefixMapping to add module-specific mappings.
    Returns:
    The map. The key of the map is the literal barcode prefix and the value is the standard name.
  - @javax.transaction.Transactional java.util.Map parseScan(ScanRequestInterface scanRequest)
    
    Attempts to parse the scanned data, looking for specific markers for specific field types (e.g. button, order, lsn, product, etc).
    Parameters:
    scanRequest - The original barcode scan request.
    Returns:
    A map containing the parsed name/value pairs found in the barcode (if any).
  - @javax.transaction.Transactional void processOrder(ScanResponseInterface scanResponse)
    
    Attempts to execute the automatic actions for an order when scanned. This includes starting the order if in queue.
    Parameters:
    scanResponse - The response with the order. Updated by this method when an action is performed.
  - @javax.transaction.Transactional @org.simplemes.eframe.custom.annotation.ExtensionPoint(value: ScanPoint, comment: The Scan dashboard scan() method) ScanResponseInterface scan(ScanRequestInterface scanRequest)
    
    Handles the scan from the user. This resolves the ID and will sometimes process the ID.
    Note: This method uses the normal Java interface pattern for arguments and return values. This is done because the optional modules will most likely replace the core objects with sub-classes.
    Parameters:
    scanRequest - The scan request to resolve.
    Returns:
    The response of the scan processing. Includes the resolve results, client actions and any messages from the actions performed by this service.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ScanService

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String BARCODE_BUTTON

public static final java.lang.String EVENT_SOURCE

Property Detail

private OrderService orderService

private ResolveService resolveService

private WorkService workService

Constructor Detail

ScanService()

Method Detail

@org.simplemes.eframe.custom.annotation.ExtensionPoint(value: GetBarcodePrefixPoint, comment: The Scan dashboard getBarcodePrefixMapping() method) java.util.Map<java.lang.String, java.lang.String> getBarcodePrefixMapping()

@javax.transaction.Transactional java.util.Map parseScan(ScanRequestInterface scanRequest)

@javax.transaction.Transactional void processOrder(ScanResponseInterface scanResponse)

@javax.transaction.Transactional @org.simplemes.eframe.custom.annotation.ExtensionPoint(value: ScanPoint, comment: The Scan dashboard scan() method) ScanResponseInterface scan(ScanRequestInterface scanRequest)