OrderService (mes-core 0.5 API)

org.simplemes.mes.demand.service.OrderService

```
@groovy.util.logging.Slf4j
@groovy.lang.Singleton
@java.lang.SuppressWarnings(value: GrMethodMayBeStatic)
class OrderService
extends java.lang.Object
```
This service provided methods to manipulate orders in SimpleMES. This contains the core business logic for orders. This provides methods to release an order for production and close an order when completed early.
Logging
The logging for this class that can be enabled:
- debug - Debugging information. Typically includes inputs and outputs.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`ACTION_RELEASE_LSN`	The ActionLog entry used for Release LSN actions.
`static java.lang.String`	`ACTION_RELEASE_ORDER`	The ActionLog entry used for Release order actions.

Properties Summary

Properties
Type	Name and description
`private long`	`lastLogTime` The time the last log warning message was triggered.

Constructor Summary

Constructors
Constructor and description
`OrderService ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.List<java.lang.String>`	`archiveOld(BigDecimal ageDays, java.lang.Long maxOrdersPerTxn, java.lang.Integer maxTxns)` Archive old, done orders based on the date that they were completed.
	`void`	`delete(Order order)` Deletes the given order and related records.
	`java.util.List<WorkableInterface>`	`determineQtyStates(Order order)` Finds all places the given order is in queue or in work.
	`java.util.List<WorkableInterface>`	`determineQtyStates(LSN lsn)` Finds all places the given LSN is in queue or in work.
	`OrderReleaseResponse`	`release(OrderReleaseRequest orderReleaseRequest)` Release the given order for production.

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 ACTION_RELEASE_LSN
    
    The ActionLog entry used for Release LSN actions.
  - public static final java.lang.String ACTION_RELEASE_ORDER
    
    The ActionLog entry used for Release order actions.
- Property Detail
  - private long lastLogTime
    
    The time the last log warning message was triggered.
- Constructor Detail
  - OrderService()
- Method Detail
  - @java.lang.SuppressWarnings(value: JavaIoPackageAccess) @groovy.transform.Synchronized java.util.List<java.lang.String> archiveOld(BigDecimal ageDays, java.lang.Long maxOrdersPerTxn, java.lang.Integer maxTxns)
    
    Archive old, done orders based on the date that they were completed. There are options for the age (days) and the max number of orders to archive in one batch (transaction). There is also an option to limit the number batches archived at a time. This last option is used to limit the slowdown from archiving during 'catch-up' scenarios when archiving has not been run recently. Values that exceed the maximum will be ignored and the maximum will be used.
    This method is typically called automatically once per day using the job scheduler.
    Note: This method creates new transactions when archiving each batch of records. If called from within an existing transaction, then no new transactions will be created.
    Parameters:
    ageDays - Any orders completed more than this number of days in the past are eligible for archive. If 0 (default), then the config setting org.simplemes.eframe.archive.ageDays is used. Fractions allowed. Default: 100
    maxOrdersPerTxn - The max number of orders to archive per transaction. Default: 100. Maximum: 500.
    maxTxns - The max number of orders to archive per transaction. Default: 5. Maximum: 50.
    Returns:
    The list of archive references created by this archive process.
  - @java.lang.SuppressWarnings(value: GrUnnecessaryDefModifier) @javax.transaction.Transactional void delete(Order order)
    
    Deletes the given order and related records. There is no confirmation for this delete. It relies on the Order#findRelatedRecords()#findRelatedRecords()
    Parameters:
    order - The order to delete.
  - java.util.List<WorkableInterface> determineQtyStates(Order order)
    
    Finds all places the given order is in queue or in work.
    Parameters:
    order - The order to query.
    Returns:
    A list of workable objects where the order is in queue or in work. Sorted on operation sequence if an operation object.
  - java.util.List<WorkableInterface> determineQtyStates(LSN lsn)
    
    Finds all places the given LSN is in queue or in work.
    Parameters:
    lsn - The LSN to query.
    Returns:
    A list of workable objects where the LSN is in queue or in work. Sorted on operation sequence if an operation object.
  - @javax.transaction.Transactional @org.simplemes.eframe.custom.annotation.ExtensionPoint(value: OrderReleasePoint, comment: The Order release() method) @java.lang.SuppressWarnings(value: GrUnnecessaryDefModifier) OrderReleaseResponse release(OrderReleaseRequest orderReleaseRequest)
    
    Release the given order for production. The order cannot be worked on the shop floor until it is released. This method makes the quantity released available for production by queueing it the appropriate entry point (first operation if there is a routing needed).
    
    Note: This method is part of the Stable API.
    Parameters:
    orderReleaseRequest - The details of the release request (order and qty).

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class OrderService

Logging

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String ACTION_RELEASE_LSN

public static final java.lang.String ACTION_RELEASE_ORDER

Property Detail

private long lastLogTime

Constructor Detail

OrderService()

Method Detail

@java.lang.SuppressWarnings(value: JavaIoPackageAccess) @groovy.transform.Synchronized java.util.List<java.lang.String> archiveOld(BigDecimal ageDays, java.lang.Long maxOrdersPerTxn, java.lang.Integer maxTxns)

@java.lang.SuppressWarnings(value: GrUnnecessaryDefModifier) @javax.transaction.Transactional void delete(Order order)

java.util.List<WorkableInterface> determineQtyStates(Order order)

java.util.List<WorkableInterface> determineQtyStates(LSN lsn)

@javax.transaction.Transactional @org.simplemes.eframe.custom.annotation.ExtensionPoint(value: OrderReleasePoint, comment: The Order release() method) @java.lang.SuppressWarnings(value: GrUnnecessaryDefModifier) OrderReleaseResponse release(OrderReleaseRequest orderReleaseRequest)