WorkableInterface (mes-core 0.5 API)

```
interface WorkableInterface
```
This interface represents the smallest possible unit that can be worked. Classes that implement this can be processed with the Work Service. These classes will provide tha ability to start and complete work on the workable element.
Note: These methods are normally provided by the WorkStateTrait logic.

Constructor Summary

Constructors
Constructor and description
`WorkableInterface ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`BigDecimal`	`completeQty(BigDecimal qty)` Completes the given qty at this workable location.
	`WorkableInterface`	`determineNextWorkable()` Determines the next workable to be performed after this workable is completed.
	`void`	`queueQty(BigDecimal qty)` Queues the given qty at this workable.
	`BigDecimal`	`reverseCompleteQty(BigDecimal qty)` Reverses the complete of work on an Order/LSN.
	`BigDecimal`	`reverseStartQty(BigDecimal qty)` Reverses the start of work on an Order/LSN.
	`BigDecimal`	`startQty(BigDecimal qty)` Starts the given qty at this workable location.
	`BigDecimal`	`startQty(BigDecimal qty, java.util.Date dateTime)` Starts the given qty at this workable location.
	`BigDecimal`	`validateCompleteQty(BigDecimal qty)` Validates that the given qty can be completed at this workable location.
	`BigDecimal`	`validateStartQty(BigDecimal qty)` Validates that the given qty can be started at this workable location.

- Constructor Detail
  - WorkableInterface()
- Method Detail
  - BigDecimal completeQty(BigDecimal qty)
    
    Completes the given qty at this workable location. This should move the qty from in work to the next step (if any)
    Parameters:
    qty - The quantity to complete. Default: all quantity in work
    Returns:
    The quantity actually completed.
  - WorkableInterface determineNextWorkable()
    
    Determines the next workable to be performed after this workable is completed.
    Returns:
    The workable. Null if there is no other workable left to be processed.
  - void queueQty(BigDecimal qty)
    
    Queues the given qty at this workable.
    Parameters:
    qty - The quantity to queue.
  - BigDecimal reverseCompleteQty(BigDecimal qty)
    
    Reverses the complete of work on an Order/LSN. This moves the done qty back to in queue.
    Parameters:
    qty - The quantity to start. Default: all of the done quantity
    Returns:
    The quantity actually reversed.
  - BigDecimal reverseStartQty(BigDecimal qty)
    
    Reverses the start of work on an Order/LSN. This moves the in work qty back to in queue.
    Parameters:
    qty - The quantity to start. Default: all quantity in work
    Returns:
    The quantity actually reversed.
  - BigDecimal startQty(BigDecimal qty)
    
    Starts the given qty at this workable location. This should move the qty from in queue to in work.
    Parameters:
    qty - The quantity to start. Default: all quantity in queue
    Returns:
    The quantity actually started.
  - BigDecimal startQty(BigDecimal qty, java.util.Date dateTime)
    
    Starts the given qty at this workable location. This should move the qty from in queue to in work.
    Parameters:
    qty - The quantity to start. Default: all quantity in queue
    dateTime - The date/time this qty is started (Default: now).
    Returns:
    The quantity actually started.
  - BigDecimal validateCompleteQty(BigDecimal qty)
    
    Validates that the given qty can be completed at this workable location.
    Parameters:
    qty - The quantity to complete. Default: all quantity in work
    Returns:
    The quantity that would be actually completed.
  - BigDecimal validateStartQty(BigDecimal qty)
    
    Validates that the given qty can be started at this workable location.
    Parameters:
    qty - The quantity to start. Default: all quantity in queue
    Returns:
    The quantity that would be actually started.

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Interface WorkableInterface

Constructor Summary

Methods Summary

Constructor Detail

WorkableInterface()

Method Detail

BigDecimal completeQty(BigDecimal qty)

WorkableInterface determineNextWorkable()

void queueQty(BigDecimal qty)

BigDecimal reverseCompleteQty(BigDecimal qty)

BigDecimal reverseStartQty(BigDecimal qty)

BigDecimal startQty(BigDecimal qty)

BigDecimal startQty(BigDecimal qty, java.util.Date dateTime)

BigDecimal validateCompleteQty(BigDecimal qty)

BigDecimal validateStartQty(BigDecimal qty)