Histórico da Página

...

Informações

Objeto oSchema

Serão feitos tratamentos internos neste objeto.

Ele possui apenas dois métodos para uso externo, usados em conjunto com os métodos da nova classe, sendo eles:

Método AliasToSchema() - Método do objeto oSchema que transforma o alias em um schema, caso seja utilizado apenas o primeiro parâmetro todos os campos serão enviados.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cAlias	Caracter	X		Alias/WorkArea que será utilizado
xField	Variante		Nil	Contém os campos que serão utilizado no schema, podendo ser caracter ou array.

Método AddProperty() - Método do objeto oSchema que adiciona uma propriedade ao schema.

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cName	Caractere	X		Nome da propriedade (Não pode conter símbolos ou caracteres especiais)
cDescription	Caractere	X		Descrição da propriedade
cType	Caractere	X		Tipo da propriedade (A partir da LIB Label 20230403 será aceito o tipo 'memo')
cDisplayName	Caractere	X		Nome de exibição da propriedade
cRealName	Caractere	X		Nome da propriedade no Protheus (Nome real do campo da tabela)
cComboValues (Disponível a partir da LIB Label 20220321)	Caractere		Ao ser utilizado o método self:setIsCBoxLookup() documentado abaixo, com o segundo parâmetro igual a .T., o cComboValues receberá o valor do combobox do campo a partir da SX3	Valores do key-label (Formato igual ao combobox da SX3, ex.: "D MG 01=Filial BH" separado por ; caso tenha mais de uma opção)
lIsRequired (Disponível a partir da LIB Label 20220321)	Lógico		.F.	Indica que será obrigatório informar um valor para o campo
cRenameField (Disponível a partir da LIB Label 20220905)	Caractere			Indica um apelido para o campo (utilizado quando a query contém campos repetidos)

Exemplos de uso estarão abaixo nos métodos criados para a classe IntegratedProvider.

Obs: O nome real é necessário para que o filtro seja feito com base no nome real do campo, caso contrário, o mesmo levará em consideração a propriedade name.

Método AddParameter() - Método do objeto oSchema que adiciona um parâmetro ao objeto de negócio.

Informações
Disponível a partir da LIB Label 20230515

Parâmetros:

Nome	Tipo	Obrigatório	Default	Descrição
cName	Caractere	X		Nome da propriedade (Não pode conter símbolos ou caracteres especiais)
cDisplayName	Caractere	X		Nome de exibição da propriedade
cType	Caractere	X		Tipo da propriedade
lIsMultiValue	Lógico		.F.	Indica se aceita múltiplos valores

Informações

Objeto oFilter

Serão feitos tratamentos internos neste objeto.

Ele possui métodos para uso externo, usados em conjunto com o método getData do objeto de negócios

Método hasFilter() - Método do objeto oFilter que indica a existência de filtros (O TReports permite filtrar os dados)

Retorno: Logical → Indica a presença de filtros

Sintaxe: oFilter:hasFilter() → logical

Método hasFields() - Método do objeto oFilter que indica se existem campos de retorno (O TReports permite retornar uma quantidade de campos menor que o objeto de negócios possui, filtrando assim os campos, não os dados)

Retorno: Logical → Indica a presença de campos de retorno

Sintaxe: oFilter:hasFields() → logical

Método getAdvplExpression() - Método do objeto oFilter que retorna os filtros no formato ADVPL

Retorno: character → Filtro de dados no formato ADVPL

Sintaxe: oFilter:getAdvplExpression() → character

Método getSQLExpression() - Método do objeto oFilter que retorna os filtros no formato SQL

Retorno: character → Filtro de dados no formato SQL

Sintaxe: oFilter:getSQLExpression() → character

Método getFields() - Método do objeto oFilter que retorna um array contendo os campos que foram solicitados (Mesma lógica do hasFields)

Retorno: array → Campos que devem ser retornados

Sintaxe: oFilter:getFields() → array

Método getRawFilter() - Método do objeto oFilter que retorna um JSON com o filtro solicitado pelo TReports em seu formato original, é com base nele que as expressões SQL e ADVPL são geradas (Mesma lógica do hasFilter)

Retorno: json → JSON com o filtro solicitado pelo TReports

Sintaxe: oFilter:getRawFilter() → json

Observação: Método só disponível na LIB 20230515 20230626 ou superior

...

GetSchema()

Retorna a Estrutura de dados.

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 97

Nova versão 98

Chave

GetSchema()