Package io.jmix.rest.impl.controller

Class QueriesController

java.lang.Object

io.jmix.rest.impl.controller.QueriesController

@RestController("rest_QueriesController")
@RequestMapping(value="${jmix.rest.base-path}${jmix.rest.queries-path}",
                produces="application/json;charset=UTF-8")
public class QueriesController
extends Object

Controller that is used for operations with predefined JPQL queries

Field Summary

Fields

Modifier and Type	Field	Description
protected QueriesControllerManager	queriesControllerManager

Constructor Summary

Constructors

Constructor	Description
QueriesController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	executeQueryGet(String entityName, String queryName, Integer limit, Integer offset, String view, String fetchPlan, Boolean returnNulls, Boolean dynamicAttributes, Boolean returnCount, String modelVersion, Map<String,String> params)
org.springframework.http.ResponseEntity<String>	executeQueryPost(String entityName, String queryName, Integer limit, Integer offset, String view, String fetchPlan, Boolean returnNulls, Boolean dynamicAttributes, Boolean returnCount, String modelVersion, String paramsJson)
String	getCountGet(String entityName, String queryName, String modelVersion, Map<String,String> params)
String	getCountGetText(String entityName, String queryName, String modelVersion, Map<String,String> params)
String	getCountPost(String entityName, String queryName, String modelVersion, String paramsJson)
String	getCountPostText(String entityName, String queryName, String modelVersion, String paramsJson)
List<RestQueriesConfiguration.QueryInfo>	loadQueriesList(String entityName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

queriesControllerManager

@Autowired
protected QueriesControllerManager queriesControllerManager

Constructor Details

QueriesController

public QueriesController()

Method Details

executeQueryGet

@GetMapping("/{entityName}/{queryName}")
public org.springframework.http.ResponseEntity<String> executeQueryGet(@PathVariable
 String entityName,
 @PathVariable
 String queryName,
 @RequestParam(required=false)
 Integer limit,
 @RequestParam(required=false)
 Integer offset,
 @Deprecated(forRemoval=true) @RequestParam(required=false)
 String view,
 @RequestParam(required=false)
 String fetchPlan,
 @RequestParam(required=false)
 Boolean returnNulls,
 @RequestParam(required=false)
 Boolean dynamicAttributes,
 @RequestParam(required=false)
 Boolean returnCount,
 @RequestParam(required=false)
 String modelVersion,
 @RequestParam
 Map<String,String> params)

executeQueryPost

@PostMapping("/{entityName}/{queryName}")
public org.springframework.http.ResponseEntity<String> executeQueryPost(@PathVariable
 String entityName,
 @PathVariable
 String queryName,
 @RequestParam(required=false)
 Integer limit,
 @RequestParam(required=false)
 Integer offset,
 @Deprecated(forRemoval=true) @RequestParam(required=false)
 String view,
 @RequestParam(required=false)
 String fetchPlan,
 @RequestParam(required=false)
 Boolean returnNulls,
 @RequestParam(required=false)
 Boolean dynamicAttributes,
 @RequestParam(required=false)
 Boolean returnCount,
 @RequestParam(required=false)
 String modelVersion,
 @RequestBody
 String paramsJson)

getCountGet

@GetMapping("/{entityName}/{queryName}/count")
public String getCountGet(@PathVariable
 String entityName,
 @PathVariable
 String queryName,
 @RequestParam(required=false)
 String modelVersion,
 @RequestParam
 Map<String,String> params)
                   throws ClassNotFoundException,
ParseException

Throws:

ClassNotFoundException

ParseException

getCountGetText

@GetMapping(value="/{entityName}/{queryName}/count",
            produces="text/plain;charset=UTF-8")
public String getCountGetText(@PathVariable
 String entityName,
 @PathVariable
 String queryName,
 @RequestParam(required=false)
 String modelVersion,
 @RequestParam
 Map<String,String> params)
                       throws ClassNotFoundException,
ParseException

Throws:

ClassNotFoundException

ParseException

getCountPost

@PostMapping("/{entityName}/{queryName}/count")
public String getCountPost(@PathVariable
 String entityName,
 @PathVariable
 String queryName,
 @RequestParam(required=false)
 String modelVersion,
 @RequestBody
 String paramsJson)
                    throws ClassNotFoundException,
ParseException

Throws:

ClassNotFoundException

ParseException

getCountPostText

@PostMapping(value="/{entityName}/{queryName}/count",
             produces="text/plain;charset=UTF-8")
public String getCountPostText(@PathVariable
 String entityName,
 @PathVariable
 String queryName,
 @RequestParam(required=false)
 String modelVersion,
 @RequestBody
 String paramsJson)
                        throws ClassNotFoundException,
ParseException

Throws:

ClassNotFoundException

ParseException

loadQueriesList

@GetMapping("/{entityName}")
public List<RestQueriesConfiguration.QueryInfo> loadQueriesList(@PathVariable
 String entityName)