OrderController (eframe 0.5 API)

sample.controller.OrderController

@groovy.util.logging.Slf4j
@io.micronaut.security.annotation.Secured(value: MANAGER)
@io.micronaut.http.annotation.Controller(value: /order)
@java.lang.SuppressWarnings(value: unused)
class OrderController
extends BaseCrudRestController

Handles the controller actions for the Order objects. Includes CRUD actions on the user.

Not shipped with the framework. Used for some GUI tests.

Field Summary

Fields
Modifiers	Name	Description
`static int`	`WORK_RECORD_COUNT`	The number of rows available for the dummy findWork() method.

Inherited fields
Fields inherited from class	Fields
`class BaseController`	`lastErrorMessage`

Properties Summary

Properties
Type	Name and description
`private static java.util.List<FindComponentResponseDetail>`	`componentList` The dummy component list values.
`private static java.lang.Object`	`domainClass`
`private static int`	`suggestCount` The number of times the suggest url is called.
`private static java.util.Map`	`suggestLatestParameters` The most recent parameters for the latest suggest request.
`private java.lang.Object`	`taskMenuItems` Defines the entry(s) in the main Task Menu.
`private static java.util.List<java.util.UUID>`	`workListUUIDs` A static list of UUIDs for the dummy work list.

Constructor Summary

Constructors
Constructor and description
`OrderController ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`io.micronaut.http.HttpResponse`	`findComponents(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Returns a list (JSON formatted) that contains a POGO list of values.
	`io.micronaut.http.HttpResponse`	`findWork(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Returns a list (JSON formatted) that contains a POGO list of values.
	`java.lang.String`	`getView(java.lang.String methodName)` Determines the view to display for the given method.
	`StandardModelAndView`	`orderComponentList(java.security.Principal principal)`
	`StandardModelAndView`	`orderWorkList(java.security.Principal principal)`
	`io.micronaut.http.HttpResponse`	`suggestOrder(io.micronaut.http.HttpRequest request, java.security.Principal principal)` Test method for a suggest list.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class BaseCrudRestController`	`restDelete, restGet, restPost, restPut`
`class BaseCrudController`	`bindEvent, create, createPost, delete, edit, editPost, getDomain, getRootPath, getView, index, list, show`
`class BaseController`	`buildDeniedResponse, buildErrorResponse, buildOkResponse, error, parseBody`

- Field Detail
  - public static final int WORK_RECORD_COUNT
    
    The number of rows available for the dummy findWork() method.
- Property Detail
  - private static java.util.List<FindComponentResponseDetail> componentList
    
    The dummy component list values.
  - private static java.lang.Object domainClass
  - private static int suggestCount
    
    The number of times the suggest url is called.
  - private static java.util.Map suggestLatestParameters
    
    The most recent parameters for the latest suggest request.
  - private java.lang.Object taskMenuItems
    
    Defines the entry(s) in the main Task Menu.
  - private static java.util.List<java.util.UUID> workListUUIDs
    
    A static list of UUIDs for the dummy work list.
- Constructor Detail
  - OrderController()
- Method Detail
  - @java.lang.SuppressWarnings(value: GroovyAssignabilityCheck) @io.micronaut.http.annotation.Get(value: /findComponents) io.micronaut.http.HttpResponse findComponents(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Returns a list (JSON formatted) that contains a POGO list of values. Dummy static list.
    Parameters:
    request - The request.
    principal - The user logged in.
    Returns:
    The data for the list.
  - @java.lang.SuppressWarnings(value: GroovyAssignabilityCheck) @io.micronaut.http.annotation.Get(value: /findWork) io.micronaut.http.HttpResponse findWork(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Returns a list (JSON formatted) that contains a POGO list of values. Dummy static list.
    Parameters:
    request - The request.
    principal - The user logged in.
    Returns:
    The data for the list.
  - @java.lang.Override java.lang.String getView(java.lang.String methodName)
    
    Determines the view to display for the given method. This can be overridden in your controller class to use a different naming scheme.
    This sub-class points to a sample directory.
    Parameters:
    methodName - The method that needs the view (e.g. 'index').
    Returns:
    The resulting view path.
  - @io.micronaut.http.annotation.Get(value: /orderComponentList) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) StandardModelAndView orderComponentList(@javax.annotation.Nullable java.security.Principal principal)
  - @io.micronaut.http.annotation.Get(value: /orderWorkList) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) StandardModelAndView orderWorkList(@javax.annotation.Nullable java.security.Principal principal)
  - @java.lang.SuppressWarnings(value: GroovyAssignabilityCheck) @io.micronaut.http.annotation.Get(value: /suggestOrder) io.micronaut.http.HttpResponse suggestOrder(io.micronaut.http.HttpRequest request, @javax.annotation.Nullable java.security.Principal principal)
    
    Test method for a suggest list. Also provides an instrumented endpoint for use with suggest API tests. Records the parameters in the latest request and a count of the calls.
    Parameters:
    request - The request.
    principal - The user logged in.
    Returns:
    The data for the list.

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class OrderController

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int WORK_RECORD_COUNT

Property Detail

private static java.util.List<FindComponentResponseDetail> componentList

private static java.lang.Object domainClass

private static int suggestCount

private static java.util.Map suggestLatestParameters

private java.lang.Object taskMenuItems

private static java.util.List<java.util.UUID> workListUUIDs

Constructor Detail

OrderController()

Method Detail

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

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

@java.lang.Override java.lang.String getView(java.lang.String methodName)

@io.micronaut.http.annotation.Get(value: /orderComponentList) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) StandardModelAndView orderComponentList(@javax.annotation.Nullable java.security.Principal principal)

@io.micronaut.http.annotation.Get(value: /orderWorkList) @io.micronaut.http.annotation.Produces(value: MediaType.TEXT_HTML) StandardModelAndView orderWorkList(@javax.annotation.Nullable java.security.Principal principal)

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