Query
Definição da configuração do objeto Query para consultas simplificadas.
all
all() : java.util.List
Descrição
Retorna todos os registros resultantes da execução da consulta, caso nenhum, retorna uma lista vazia.
Retorno
( java.util.List )
Lista de registros.
debug
debug(activo: boolean) : Query
Descrição
Define se o debug está ativo ou não na consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| activo | boolean | Se o debug está ativo ou não. |
Retorno
( Query )
Objeto Query atual.
distinct
distinct(activo: boolean) : Query
Descrição
Define se será aplicado o comando DISTINCT á consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| activo | boolean | Se será aplicado ou não. |
Retorno
( Query )
Objeto Query atual.
fields
fields(campos: [Lorg.netuno.tritao.query.Field;[]) : Query
Descrição
Define os campos que serão obtidos na consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campos | [Lorg.netuno.tritao.query.Field;[] | Campos que serão obtidos na consulta. |
Retorno
( Query )
Objeto Query atual.
first
first() : Values
Descrição
Retorna o primeiro registro resultante da execução da consulta, caso nenhum, retorna null.
Retorno
( Values )
Primeiro registro do resultado.
getFields
getFields() : java.util.List
Descrição
Retorna os campos que serão obtidos na consulta.
Retorno
( java.util.List )
Campos que serão obtidos na consulta.
getGroup
getGroup() : Group
Descrição
Retorna o objeto de agrupamento da consulta.
Retorno
( Group )
Objeto de agrupamento da consulta.
getJoin
getJoin() : Config | Exec | Header | Req | Res | Values | DataSchema
Descrição
Retorna os objetos Join (tabelas relacionadas) referente a tabela principal da consulta.
Retorno
( Config | Exec | Header | Req | Res | Values | DataSchema )
Objetos Join (tabelas relacionadas) referente a tabela principal da consulta.
getOrder
getOrder() : Order
Descrição
Retorna o objeto de ordenação da consulta.
Retorno
( Order )
Objeto de ordenação da consulta.
getPagination
getPagination() : org.netuno.tritao.query.pagination.Pagination
Descrição
Retorna o objeto de configuração da paginação (se houver) da consulta.
Retorno
( org.netuno.tritao.query.pagination.Pagination )
Objeto de configuração da paginação (se houver) da consulta.
getTableName
getTableName() : string
Descrição
Retorna o nome da tabela principal da consulta.
Retorno
( string )
Nome da tabela principal da consulta.
getTablesToPopulate
getTablesToPopulate() : java.util.List
Retorno
( java.util.List )
getWhere
getWhere() : Where
Descrição
Retorna o object Where referente a tabela principal da consulta.
Retorno
( Where )
Objeto Where da tabela principal da consulta.
group
group(order: string) : Query
Descrição
Define o objeto de agrupamento da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| order | string | Objeto de ordenação da consulta. |
Retorno
( Query )
Objeto Query atual.
isDebug
isDebug() : boolean
Descrição
Retorna se o debug está ativo ou não na consulta.
Retorno
( boolean )
Se o debug está ativo ou não na consulta.
isDistinct
isDistinct() : boolean
Descrição
Retorna se será aplicado o comando DISTINCT á consulta.
Retorno
( boolean )
Se será aplicado ou não.
join
join(relacao: Relation) : Query
Descrição
Define uma relacão de tipo INNER JOIN com uma tabela.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| relacao | Relation | Relação do tipo INNER JOIN. |
Retorno
( Query )
Objeto Query atual.
leftJoin
leftJoin(relacao: Relation) : Query
Descrição
Define uma relacão de tipo LEFT JOIN com uma tabela.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| relacao | Relation | Relação do tipo LEFT JOIN. |
Retorno
( Query )
Objeto Query atual.
link
link(formLink: string) : Query
Descrição
Define um formulario para ser relacionado com a tabela principal da consulta usando os criterios do Link.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| formLink | string | Formulario a ser relacionada. |
Retorno
( Query )
Objeto Query atual.
link(formLink: string, link: Link) : Query
Descrição
Define um formulario para ser relacionado com a tabela principal da consulta usando os critérios do Link.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| formLink | string | Formulario a ser relacionada. |
| link | Link | Objeto Link com uma subrelação. |
Retorno
( Query )
Objeto Query atual.
link(formLink: string, where: Where) : Query
Descrição
Define um formulario para ser relacionado com a tabela principal da consulta usando os criterios do Link.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| formLink | string | Formulario a ser relacionada. |
| where | Where | Objeto Where com as condições referente ao formulario que deseja relacionar. |
Retorno
( Query )
Objeto Query atual.
link(formLink: string, where: Where, link: Link) : Query
Descrição
Define um formulario para ser relacionado com a tabela principal da consulta usando os critérios do Link.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| formLink | string | Formulario a ser relacionada. |
| where | Where | Objeto Where com as condições referente ao formulario que deseja relacionar. |
| link | Link | Objeto Link com uma subrelação. |
Retorno
( Query )
Objeto Query atual.
order
order(coluna: string, sentido: string) : Query
Descrição
Define a ordenação da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| coluna | string | Coluna para ordenação. |
| sentido | string | Sentido da ordenação. |
Retorno
( Query )
Objeto Query atual.
page
page(paginacao: org.netuno.tritao.query.pagination.Pagination) : Values
Descrição
Retorna Pagina com os items resultante da execução da consulta de forma paginada e demais dados da paginação.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| paginacao | org.netuno.tritao.query.pagination.Pagination | Objeto Pagination com as configurações da paginação. |
Retorno
( Values )
Pagina com os items e demais dados da paginação.
populate
populate(table: string, filter: Field) : Query
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| table | string | |
| filter | Field |
Retorno
( Query )
populate(table: string, filter: Field, fields: java.util.List) : Query
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| table | string | |
| filter | Field | |
| fields | java.util.List |
Retorno
( Query )
rightJoin
rightJoin(relacao: Relation) : Query
Descrição
Define uma relacão de tipo RIGHT JOIN com uma tabela.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| relacao | Relation | Relação do tipo RIGHT JOIN. |
Retorno
( Query )
Objeto Query atual.
setDebug
setDebug(activo: boolean) : Query
Descrição
Define se o debug está ativo ou não na consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| activo | boolean | Se o debug está ativo ou não. |
Retorno
( Query )
Objeto Query atual.
setDistinct
setDistinct(activo: boolean) : Query
Descrição
Define se será aplicado o comando DISTINCT á consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| activo | boolean | Se será aplicado ou não. |
Retorno
( Query )
Objeto Query atual.
setFields
setFields(campos: java.util.List) : Query
Descrição
Define os campos que serão obtidos na consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campos | java.util.List | Campos que serão obtidos na consulta. |
Retorno
( Query )
Objeto Query atual.
setGroup
setGroup(order: Group) : Query
Descrição
Define o objeto de agrupamento da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| order | Group | Objeto de ordenação da consulta. |
Retorno
( Query )
Objeto Query atual.
setJoin
setJoin(join: Config | Exec | Header | Req | Res | Values | DataSchema) : Query
Descrição
Define os objetos Join (tabelas relacionadas) referente a tabela principal da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| join | Config | Exec | Header | Req | Res | Values | DataSchema | Objetos Join (tabelas relacionadas) referente a tabela principal da consulta. |
Retorno
( Query )
Objeto Query atual.
setOrder
setOrder(order: Order) : Query
Descrição
Define o objeto de ordenação da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| order | Order | Objeto de ordenação da consulta. |
Retorno
( Query )
Objeto Query atual.
setPagination
setPagination(paginacao: org.netuno.tritao.query.pagination.Pagination) : Query
Descrição
Define o objeto de configuração da paginação (se houver) da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| paginacao | org.netuno.tritao.query.pagination.Pagination | objeto de configuração da paginação da consulta. |
Retorno
( Query )
Objeto Query atual.
setTableName
setTableName(nomeTabela: string) : Query
Descrição
Define o nome da tabela principal da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| nomeTabela | string | Nome da tabela principal. |
Retorno
( Query )
Objeto Query atual.
setTablesToPopulate
setTablesToPopulate(tablesToPopulate: java.util.List) : Query
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| tablesToPopulate | java.util.List |
Retorno
( Query )
setWhere
setWhere(where: Where) : Query
Descrição
Define o object Where referente a tabela principal da consulta.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| where | Where | Objeto Where da tabela principal da consulta. |
Retorno
( Query )
Objeto Query atual.