WorkStateTrait (mes-core 0.5 API)

org.simplemes.mes.demand.WorkStateTrait

```
@groovy.transform.Trait
trait WorkStateTrait
extends java.lang.Object
```
Provides the Domain classes with a generic Work State. This object holds the work state of an operation or an overall object (e.g. Order or LSN). This work state contains the quantities in queue, work and done.
This abstract base class provides the basic quantity fields and interface methods. Sub-classes will normally provide foreign keys to link this work state to the parent object (e.g. Order or LSN).
Note: Implementers of this trait should provide a meaningful toString() method (used for error messages).
Required Fields in Domain Classes
The following fields must be implemented in the domain entity class:
- qtyInQueue - The number of pieces waiting to be worked (in queue) for this object.
- qtyInWork - The number of pieces actively in work for this object.
- qtyDone - The number of pieces to completed (done) on this object.
- dateQtyQueued - The date/time any quantity was queued at this point (operation or top-level). Can be null if the nothing is in queue.
- dateQtyStarted - The date/time any quantity was started at this point (operation or top-level). Can be null if the nothing is in work.
- dateFirstQueued - The date/time any quantity was first queued at this point (operation or top-level).
- dateFirstStarted - The date/time any quantity was first started at this point (operation or top-level).

Properties Summary

Properties
Type	Name and description
`java.util.Date`	`dateFirstQueued`
`java.util.Date`	`dateFirstStarted`
`java.util.Date`	`dateQtyQueued`
`java.util.Date`	`dateQtyStarted`
`BigDecimal`	`qtyDone`
`BigDecimal`	`qtyInQueue`
`BigDecimal`	`qtyInWork`

Constructor Summary

Constructors
Constructor and description
`WorkStateTrait ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`BigDecimal`	`completeQty(BigDecimal qty)` Completes the given qty at this order (top-level) location.
	`java.util.Date`	`getDateFirstQueued()`
	`java.util.Date`	`getDateFirstStarted()`
	`java.util.Date`	`getDateQtyQueued()`
	`java.util.Date`	`getDateQtyStarted()`
	`BigDecimal`	`getQtyDone()`
	`BigDecimal`	`getQtyInQueue()`
	`BigDecimal`	`getQtyInWork()`
	`void`	`queueQty(BigDecimal qty, java.util.Date dateTime)` Queues the given qty at this workable.
	`BigDecimal`	`reverseCompleteQty(BigDecimal qty, java.util.Date dateTime)` Reverses the complete of work on an Order/LSN.
	`BigDecimal`	`reverseStartQty(BigDecimal qty, java.util.Date dateTime)` Reverses the start of work on an Order/LSN.
	`void`	`saveChanges()` Implementers must provide a save() method.
	`void`	`setDateFirstQueued(java.util.Date dateFirstQueued)`
	`void`	`setDateFirstStarted(java.util.Date dateFirstStarted)`
	`void`	`setDateQtyQueued(java.util.Date dateQtyQueued)`
	`void`	`setDateQtyStarted(java.util.Date dateQtyStarted)`
	`java.lang.Object`	`setDatesAsNeeded(java.util.Date dateTime)` Sets the dates queued/started if the appropriate qty is non-zero.
	`void`	`setQtyDone(BigDecimal qtyDone)`
	`void`	`setQtyInQueue(BigDecimal qtyInQueue)` Basic setter.
	`void`	`setQtyInWork(BigDecimal qtyInWork)` Basic setter.
	`BigDecimal`	`startQty(BigDecimal qty, java.util.Date dateTime)` Starts the given qty at this order (top-level) location.
	`BigDecimal`	`validateCompleteQty(BigDecimal qty)` Validates that the given qty can be completed at this workable location.
	`BigDecimal`	`validateReverseCompleteQty(BigDecimal qty)` Validates that the given qty can be reverse completed at this workable location.
	`BigDecimal`	`validateStartQty(BigDecimal qty)` Validates that the given qty can be started at this workable location.

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

- Property Detail
  - java.util.Date dateFirstQueued
  - java.util.Date dateFirstStarted
  - java.util.Date dateQtyQueued
  - java.util.Date dateQtyStarted
  - BigDecimal qtyDone
  - BigDecimal qtyInQueue
  - BigDecimal qtyInWork
- Constructor Detail
  - WorkStateTrait()
- Method Detail
  - BigDecimal completeQty(BigDecimal qty)
    
    Completes the given qty at this order (top-level) location. This moves the qty from 'in work' to 'done'.
    Parameters:
    qty - The quantity to complete. Default: all quantity in work
    Returns:
    The quantity actually completed.
  - java.util.Date getDateFirstQueued()
  - java.util.Date getDateFirstStarted()
  - java.util.Date getDateQtyQueued()
  - java.util.Date getDateQtyStarted()
  - BigDecimal getQtyDone()
  - BigDecimal getQtyInQueue()
  - BigDecimal getQtyInWork()
  - void queueQty(BigDecimal qty, java.util.Date dateTime)
    
    Queues the given qty at this workable. This method does not trigger the save() on the workable element.
    Parameters:
    qty - The quantity to queue.
    dateTime - The date/time this qty is queued (Default: now).
  - BigDecimal reverseCompleteQty(BigDecimal qty, java.util.Date dateTime)
    
    Reverses the complete of work on an Order/LSN. This moves the in work qty back to in queue.
    Parameters:
    qty - The quantity to reverse the complete for.
    dateTime - The date/time this qty completed is reversed (Default: now).
    Returns:
    The quantity actually reversed.
  - BigDecimal reverseStartQty(BigDecimal qty, java.util.Date dateTime)
    
    Reverses the start of work on an Order/LSN. This moves the in work qty back to in queue.
    Parameters:
    qty - The quantity to reverse the start for.
    dateTime - The date/time this qty start is reversed (Default: now).
    Returns:
    The quantity actually reversed.
  - void saveChanges()
    
    Implementers must provide a save() method. This should save() changes to the record.
  - void setDateFirstQueued(@javax.annotation.Nullable java.util.Date dateFirstQueued)
  - void setDateFirstStarted(@javax.annotation.Nullable java.util.Date dateFirstStarted)
  - void setDateQtyQueued(@javax.annotation.Nullable java.util.Date dateQtyQueued)
  - void setDateQtyStarted(@javax.annotation.Nullable java.util.Date dateQtyStarted)
  - java.lang.Object setDatesAsNeeded(java.util.Date dateTime)
    
    Sets the dates queued/started if the appropriate qty is non-zero.
    Parameters:
    dateTime - The date/time this qty is started (Default: now).
  - void setQtyDone(BigDecimal qtyDone)
  - void setQtyInQueue(BigDecimal qtyInQueue)
    
    Basic setter. Also sets the dateFirstQueued is needed.
    Parameters:
    qtyInQueue - The qty.
  - void setQtyInWork(BigDecimal qtyInWork)
    
    Basic setter. Also sets the dateFirstStarted is needed.
    Parameters:
    qtyInWork - The qty.
  - BigDecimal startQty(BigDecimal qty, java.util.Date dateTime)
    
    Starts the given qty at this order (top-level) location. This moves the qty from 'in queue' to 'in work'. Saves the changes to the order.
    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 validateReverseCompleteQty(BigDecimal qty)
    
    Validates that the given qty can be reverse completed at this workable location.
    Parameters:
    qty - The quantity to reverse complete. Default: all quantity done
    Returns:
    The quantity that would be actually reversed 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:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Trait WorkStateTrait

Required Fields in Domain Classes

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Date dateFirstQueued

java.util.Date dateFirstStarted

java.util.Date dateQtyQueued

java.util.Date dateQtyStarted

BigDecimal qtyDone

BigDecimal qtyInQueue

BigDecimal qtyInWork

Constructor Detail

WorkStateTrait()

Method Detail

BigDecimal completeQty(BigDecimal qty)

java.util.Date getDateFirstQueued()

java.util.Date getDateFirstStarted()

java.util.Date getDateQtyQueued()

java.util.Date getDateQtyStarted()

BigDecimal getQtyDone()

BigDecimal getQtyInQueue()

BigDecimal getQtyInWork()

void queueQty(BigDecimal qty, java.util.Date dateTime)

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

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

void saveChanges()

void setDateFirstQueued(@javax.annotation.Nullable java.util.Date dateFirstQueued)

void setDateFirstStarted(@javax.annotation.Nullable java.util.Date dateFirstStarted)

void setDateQtyQueued(@javax.annotation.Nullable java.util.Date dateQtyQueued)

void setDateQtyStarted(@javax.annotation.Nullable java.util.Date dateQtyStarted)

java.lang.Object setDatesAsNeeded(java.util.Date dateTime)

void setQtyDone(BigDecimal qtyDone)

void setQtyInQueue(BigDecimal qtyInQueue)

void setQtyInWork(BigDecimal qtyInWork)

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

BigDecimal validateCompleteQty(BigDecimal qty)

BigDecimal validateReverseCompleteQty(BigDecimal qty)

BigDecimal validateStartQty(BigDecimal qty)