OrderStatus (mes-core 0.5 API)

org.simplemes.mes.demand.OrderStatus

All Implemented Interfaces and Traits:

org.simplemes.eframe.data.EncodedTypeInterface, org.simplemes.eframe.data.ChoiceListInterface, org.simplemes.eframe.data.ChoiceListItemInterface
```
@groovy.transform.ToString(includeNames: true, includePackage: false, excludes: [value])
abstract class OrderStatus
extends java.lang.Object
implements org.simplemes.eframe.data.EncodedTypeInterface, org.simplemes.eframe.data.ChoiceListInterface, org.simplemes.eframe.data.ChoiceListItemInterface
```
Defines the basic status codes needed for Orders. This Status controls the overall status of the order. Sub-elements of the order may have other states or statuses.
Core Statuses
The core statuses for Orders include:
- OrderCreatedStatus
- OrderReadyStatus - Default
- OrderHoldStatus
- OrderDoneStatus

Field Summary

Fields
Modifiers	Name	Description
`static int`	`ID_LENGTH`	The max length of the database representation of this status 8.

Properties Summary

Properties
Type	Name and description
`private static java.util.List<java.lang.Class>`	`coreValues` A list of classes that are valid Basic Statuses.
`private java.lang.Boolean`	`defaultChoice` True if this choice is the default choice in the list.

Constructor Summary

Constructors
Constructor and description
`OrderStatus ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static OrderStatus`	`getDefault()` Returns the default status.
	`java.lang.String`	`getDisplayValue()` Returns the display value for the choice list.
	`static OrderStatus`	`getDoneStatus()` Returns the standard done status.
	`static java.util.List<ChoiceListItemInterface>`	`getValidValues(org.simplemes.eframe.data.FieldDefinitionInterface fieldDefinition)` Returns the list of valid values for those formats that use a combobox or similar widget.
	`java.lang.Object`	`getValue()` Returns the value for the choice list (e.g. a domain record of enum element).
	`boolean`	`isDefaultChoice()` Returns true if this choice is the default choice in the list.
	`boolean`	`isDone()` Returns true if this status means that the object is done.
	`boolean`	`isWorkable()` Returns true if this status means that the object is workable.
	`java.lang.String`	`toStringLocalized(java.util.Locale locale)` Returns the localized display value for the choice.
	`static OrderStatus`	`valueOf(java.lang.String id)` Returns the instance for the given DB ID.

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 int ID_LENGTH
    
    The max length of the database representation of this status 8.
- Property Detail
  - private static java.util.List<java.lang.Class> coreValues
    
    A list of classes that are valid Basic Statuses.
  - private java.lang.Boolean defaultChoice
    
    True if this choice is the default choice in the list.
- Constructor Detail
  - OrderStatus()
- Method Detail
  - static OrderStatus getDefault()
    
    Returns the default status.
    Returns:
    The default status.
  - java.lang.String getDisplayValue()
    
    Returns the display value for the choice list.
    Returns:
    The display value.
  - static OrderStatus getDoneStatus()
    
    Returns the standard done status.
    Returns:
    The done status.
  - static java.util.List<ChoiceListItemInterface> getValidValues(org.simplemes.eframe.data.FieldDefinitionInterface fieldDefinition)
    
    Returns the list of valid values for those formats that use a combobox or similar widget.
    Parameters:
    fieldDefinition - The field definition used to define this field (optional, provided additional details such as valid values).
    Returns:
    The list of valid values.
  - @java.lang.Override java.lang.Object getValue()
    
    Returns the value for the choice list (e.g. a domain record of enum element).
    Returns:
    The value.
  - @java.lang.Override boolean isDefaultChoice()
    
    Returns true if this choice is the default choice in the list.
    Returns:
    True if it is the default.
  - boolean isDone()
    
    Returns true if this status means that the object is done.
    Returns:
    True if done.
  - boolean isWorkable()
    
    Returns true if this status means that the object is workable.
    Returns:
    True if workable.
  - @java.lang.Override java.lang.String toStringLocalized(java.util.Locale locale)
    
    Returns the localized display value for the choice.
    Parameters:
    locale - The locale to use for the localized string (Default: default locale).
    Returns:
    The display value.
  - static OrderStatus valueOf(java.lang.String id)
    
    Returns the instance for the given DB ID.
    Parameters:
    id - The ID (e.g. 'CREATED').
    Returns:
    The corresponding status (can be null if ID is not valid or null).

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class OrderStatus

Core Statuses

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int ID_LENGTH

Property Detail

private static java.util.List<java.lang.Class> coreValues

private java.lang.Boolean defaultChoice

Constructor Detail

OrderStatus()

Method Detail

static OrderStatus getDefault()

java.lang.String getDisplayValue()

static OrderStatus getDoneStatus()

static java.util.List<ChoiceListItemInterface> getValidValues(org.simplemes.eframe.data.FieldDefinitionInterface fieldDefinition)

@java.lang.Override java.lang.Object getValue()

@java.lang.Override boolean isDefaultChoice()

boolean isDone()

boolean isWorkable()

@java.lang.Override java.lang.String toStringLocalized(java.util.Locale locale)

static OrderStatus valueOf(java.lang.String id)