OrderAssyController (mes-assy 0.5 API)

org.simplemes.mes.assy.demand.controller.OrderAssyController

```
@groovy.util.logging.Slf4j
@io.micronaut.security.annotation.Secured(value: OPERATOR)
@io.micronaut.http.annotation.Controller(value: /orderAssy)
class OrderAssyController
extends org.simplemes.eframe.controller.BaseController
```
The OrderAssy controller. Provides basic access to the OrderAssyService. Does NOT provide CRUD access to any domain class.
Logging
The logging for this class that can be enabled:
- debug - Debugging information. Typically includes inputs and outputs.

Inherited fields
Fields inherited from class	Fields
`class org.simplemes.eframe.controller.BaseController`	`__$stMC`

Properties Summary

Properties
Type	Name and description
`private OrderAssyService`	`orderAssyService` The actual order assy service needed to process requests.
`private java.lang.Object`	`taskMenuItems` Defines the standard end-user task entry points that this controller handles.

Constructor Summary

Constructors
Constructor and description
`OrderAssyController ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`io.micronaut.http.HttpResponse`	`addComponent(java.lang.String body, java.security.Principal principal)` This method adds a component to the order/LSN.
	`org.simplemes.eframe.controller.StandardModelAndView`	`assembleComponentDialog(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Displays the assemble component dialog for a single component with Flex Type.
	`org.simplemes.eframe.controller.StandardModelAndView`	`assemblyActivity(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Displays the core assembly activity page.
	`io.micronaut.http.HttpResponse`	`findComponentAssemblyState(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Returns the assembly state of a given order/LSN.
	`io.micronaut.http.HttpResponse`	`removeComponent(java.lang.String body, java.security.Principal principal)` This method removes a component to the order/LSN.
	`org.simplemes.eframe.controller.StandardModelAndView`	`removeComponentDialog(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Displays the remove component dialog for a single component with Flex Type.
	`io.micronaut.http.HttpResponse`	`removeComponents(java.lang.String body, java.security.Principal principal)` This method removes one or more components from an order.
	`OrderAssembledComponent`	`resolveComponent(java.util.Map params)` Resolves the assembleComponentDialog() HTTP parameters into a prototype OrderAssembledComponent object that is used for the dialog field's model.
	`io.micronaut.http.HttpResponse`	`undoRemoveComponent(java.lang.String body, java.security.Principal principal)` This method restores the removed component to the order.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.simplemes.eframe.controller.BaseController`	org.simplemes.eframe.controller.BaseController#error(io.micronaut.http.HttpRequest, java.lang.Throwable), org.simplemes.eframe.controller.BaseController#getMetaClass(), org.simplemes.eframe.controller.BaseController#setMetaClass(groovy.lang.MetaClass), org.simplemes.eframe.controller.BaseController#buildErrorResponse(java.lang.String), org.simplemes.eframe.controller.BaseController#buildOkResponse(java.lang.Object), org.simplemes.eframe.controller.BaseController#buildOkResponse(), org.simplemes.eframe.controller.BaseController#buildDeniedResponse(io.micronaut.http.HttpRequest, java.lang.String, java.security.Principal), org.simplemes.eframe.controller.BaseController#parseBody(io.micronaut.http.HttpRequest, java.lang.Class), org.simplemes.eframe.controller.BaseController#wait(long, int), org.simplemes.eframe.controller.BaseController#wait(), org.simplemes.eframe.controller.BaseController#wait(long), org.simplemes.eframe.controller.BaseController#equals(java.lang.Object), org.simplemes.eframe.controller.BaseController#toString(), org.simplemes.eframe.controller.BaseController#hashCode(), org.simplemes.eframe.controller.BaseController#getClass(), org.simplemes.eframe.controller.BaseController#notify(), org.simplemes.eframe.controller.BaseController#notifyAll(), org.simplemes.eframe.controller.BaseController#getProperty(java.lang.String), org.simplemes.eframe.controller.BaseController#setProperty(java.lang.String, java.lang.Object), org.simplemes.eframe.controller.BaseController#invokeMethod(java.lang.String, java.lang.Object)

- Property Detail
  - private OrderAssyService orderAssyService
    
    The actual order assy service needed to process requests.
  - private java.lang.Object taskMenuItems
    
    Defines the standard end-user task entry points that this controller handles.
- Constructor Detail
  - OrderAssyController()
- Method Detail
  - @io.micronaut.http.annotation.Post(value: /addComponent) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse addComponent(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)
    
    This method adds a component to the order/LSN. This exposes the OrderAssyService method of the same name. The argument is parsed from the request input body (JSON).
    Input: AddOrderAssembledComponentRequest (JSON format).
    Response: OrderAssembledComponent (JSON format)
  - @java.lang.SuppressWarnings(value: unused) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) @io.micronaut.http.annotation.Get(value: /assembleComponentDialog) org.simplemes.eframe.controller.StandardModelAndView assembleComponentDialog(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Displays the assemble component dialog for a single component with Flex Type.
    HTTP Parameters
    The supported parameters are:
    - order - The order to add the components for (order or lsn is required).
    - lsn - The lsn to add the components for (order or lsn is required).
    - component - The component to assembled (required).
    - bomSequence - The BOM Sequence for the component to assemble (Optional).
    - assemblyData - The FlexType used to define the data fields to collect (Optional).
    Parameters:
    request - The request.
    principal - The user logged in.
    Returns:
    The model/view to display.
  - @java.lang.SuppressWarnings(value: unused) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) @io.micronaut.http.annotation.Get(value: /assemblyActivity) org.simplemes.eframe.controller.StandardModelAndView assemblyActivity(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Displays the core assembly activity page.
    Parameters:
    request - The request.
    principal - The user logged in.
    Returns:
    The model/view to display.
  - @io.micronaut.http.annotation.Get(value: /findComponentAssemblyState) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse findComponentAssemblyState(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Returns the assembly state of a given order/LSN. Returns a standard JSON list of OrderComponentState POGOs. This includes the normal total_count value. Also included is a boolean 'fullyAssembled' that is true if the order/lsn is fully assembled.
    HTTP Parameters
    The supported parameters are:
    - order - The order to find the components for (order or lsn is required).
    - lsn - The lsn to find the components for (order or lsn is required).
    - hideAssembled - If 'true', then hide any completely assembled components from the results (default: false).
    Response
    A JSON formatted map with these elements:
    - data - List OrderComponentState (JSON format)
    - total_count - The number of component records in the list.
    - fullyAssembled - 'true' if the order is fully assembled.
  - @io.micronaut.http.annotation.Post(value: /removeComponent) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse removeComponent(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)
    
    This method removes a component to the order/LSN. This exposes the OrderAssyService method of the same name. The argument is parsed from the request input body (JSON).
    Input: RemoveOrderAssembledComponentRequest (JSON format).
    Response: The response includes these two top-level elements in a map (JSON):
    - orderAssembledComponent - The OrderAssembledComponent that was removed for this request. OrderAssembledComponent.
    - undoActions - The list of undo actions needed to reverse this removal.
  - @java.lang.SuppressWarnings(value: [unused]) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) @io.micronaut.http.annotation.Get(value: /removeComponentDialog) org.simplemes.eframe.controller.StandardModelAndView removeComponentDialog(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Displays the remove component dialog for a single component with Flex Type.
    HTTP Parameters
    The supported parameters are:
    - order - The order to add the components for (Required).
    - sequences - The OrderAssembledComponent sequence(s) that can be removed (Required). A comma delimited list of sequences.
    Parameters:
    request - The request.
    principal - The user logged in.
    Returns:
    The model/view to display.
  - @io.micronaut.http.annotation.Post(value: /removeComponents) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse removeComponents(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)
    
    This method removes one or more components from an order. This uses the list of sequences to determine which record to mark as removed.
    
    JSON Body elements
    The supported parameters are:
    - order - The order to add the components for (Required).
    - sequences - The OrderAssembledComponent sequence(s) that can be removed (Required). A comma delimited list of sequences.
    Response: The response includes these two top-level elements in a map (JSON):
    - orderAssembledComponents - The List of OrderAssembledComponent that were removed for this request. OrderAssembledComponent.
    - undoActions - The list of undo actions needed to reverse this removal.
    Note: This method creates a single transaction for the removal of multiple components.
  - OrderAssembledComponent resolveComponent(java.util.Map params)
    
    Resolves the assembleComponentDialog() HTTP parameters into a prototype OrderAssembledComponent object that is used for the dialog field's model.
    Parameters:
    params - The HTTP params.
    Returns:
    The OrderAssembledComponent prototype for the planned component.
  - @io.micronaut.http.annotation.Post(value: /undoRemoveComponent) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse undoRemoveComponent(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)
    
    This method restores the removed component to the order. This exposes the OrderAssyService method of the same name. The argument is parsed from the request input body (JSON).
    Input: RemoveOrderAssembledComponentRequest (JSON format).
    Response: JSON formatted OrderAssembledComponent.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class OrderAssyController

Logging

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private OrderAssyService orderAssyService

private java.lang.Object taskMenuItems

Constructor Detail

OrderAssyController()

Method Detail

@io.micronaut.http.annotation.Post(value: /addComponent) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse addComponent(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)

HTTP Parameters

@io.micronaut.http.annotation.Get(value: /findComponentAssemblyState) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse findComponentAssemblyState(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)

HTTP Parameters

Response

@io.micronaut.http.annotation.Post(value: /removeComponent) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse removeComponent(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)

HTTP Parameters

@io.micronaut.http.annotation.Post(value: /removeComponents) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse removeComponents(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)

JSON Body elements

OrderAssembledComponent resolveComponent(java.util.Map params)

@io.micronaut.http.annotation.Post(value: /undoRemoveComponent) @java.lang.SuppressWarnings(value: unused) io.micronaut.http.HttpResponse undoRemoveComponent(@io.micronaut.http.annotation.Body java.lang.String body, @javax.annotation.Nullable java.security.Principal principal)