Package com.onec.ui

Class DocumentQueryService

java.lang.Object

com.onec.ui.DocumentQueryService

public class DocumentQueryService
extends Object

Read-side queries for documents (list with optional date range; detail with tabular sections), shared by the REST API and the DivKit emitters. Pure data access — access control stays with the callers.

Constructor Summary

Constructors

Constructor	Description
DocumentQueryService(MetadataRegistry registry, org.jdbi.v3.core.Jdbi jdbi)

Method Summary

Modifier and Type	Method	Description
BigDecimal	aggregate(DocumentDescriptor desc, String metric, String field, String filter)	A single aggregate value for a count/metric card — count of rows, or sum|avg|min|max of one numeric column — restricted to live records and narrowed by an optional safe filter predicate (see WidgetFilter).
long	count(DocumentDescriptor desc)
long	count(DocumentDescriptor desc, String search, String from, String to, List<String> eq, List<String> in, List<String> like, List<String> prefix, List<String> ge, List<String> le)	Total live rows matching the search (+ optional date range and declarative filters).
DocumentDescriptor	forClass(Class<?> clazz)	The document descriptor for a domain class, or null if it isn't a registered document.
Map<String,Object>	get(DocumentDescriptor desc, UUID id)
List<Map<String,Object>>	list(DocumentDescriptor desc, String from, String to)
List<Map<String,Object>>	page(DocumentDescriptor desc, int offset, int limit, String sortColumn, boolean descending, String search, String from, String to, List<String> eq, List<String> in, List<String> like, List<String> prefix, List<String> ge, List<String> le)	One page of a document list — server-side sorted, filtered, optionally date-ranged.
DocumentDescriptor	require(String name)
List<Map<String,Object>>	search(DocumentDescriptor desc, String query, int limit)	Capped, case-insensitive typeahead by document number — the document-ref-picker counterpart of the catalog search.
Set<String>	sortableColumns(DocumentDescriptor desc)	Columns that may be sorted on: the system columns + every attribute column.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentQueryService

public DocumentQueryService(MetadataRegistry registry,
 org.jdbi.v3.core.Jdbi jdbi)

Method Details

require

public DocumentDescriptor require(String name)

forClass

public DocumentDescriptor forClass(Class<?> clazz)

The document descriptor for a domain class, or null if it isn't a registered document.

list

public List<Map<String,Object>> list(DocumentDescriptor desc,
 String from,
 String to)

search

public List<Map<String,Object>> search(DocumentDescriptor desc,
 String query,
 int limit)

Capped, case-insensitive typeahead by document number — the document-ref-picker counterpart of the catalog search. Live records only, newest first.

count

public long count(DocumentDescriptor desc)

page

public List<Map<String,Object>> page(DocumentDescriptor desc,
 int offset,
 int limit,
 String sortColumn,
 boolean descending,
 String search,
 String from,
 String to,
 List<String> eq,
 List<String> in,
 List<String> like,
 List<String> prefix,
 List<String> ge,
 List<String> le)

One page of a document list — server-side sorted, filtered, optionally date-ranged. The engine behind the virtualized/paged list grid. sortColumn is validated against the entity's columns; search matches case-insensitively across the text columns.

count

public long count(DocumentDescriptor desc,
 String search,
 String from,
 String to,
 List<String> eq,
 List<String> in,
 List<String> like,
 List<String> prefix,
 List<String> ge,
 List<String> le)

Total live rows matching the search (+ optional date range and declarative filters).

sortableColumns

public Set<String> sortableColumns(DocumentDescriptor desc)

Columns that may be sorted on: the system columns + every attribute column.

aggregate

public BigDecimal aggregate(DocumentDescriptor desc,
 String metric,
 String field,
 String filter)

A single aggregate value for a count/metric card — count of rows, or sum|avg|min|max of one numeric column — restricted to live records and narrowed by an optional safe filter predicate (see WidgetFilter).

get

public Map<String,Object> get(DocumentDescriptor desc,
 UUID id)