Histórico da Página
...
Método que define os campos que serão retornados no Json do serviço.
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
aCampos | Array | Array que contém o De / Para dos campos que serão apresentados no serviço | X |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local aCampos := {}
Aadd(aCampos, {“code”, “A1_CODIGO”})
Aadd(aCampos, {“name”, “A1_NOME”})
oCorePanel:SetFields(aCampos) |
...
Método que define a query que será utilizada no serviço.
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
cQuery |
Caracteres | Recebe a query que será executada. | X |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local cQuery := “”
cQuery := “ SELECT A1_COD, A1_NOME FROM " + RetSqlName("SA1") + " SA1 ”
oCorePanel:SetQuery(cQuery) |
...
Método que define a clausula Where que where que será no método SetQuery().
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
cWhere |
Caracteres | Where que será utilizado na query enviada para o método SetQuery() |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New() Local cQuery := “ SELECT A1_COD, A1_NOME FROM "+ RetSqlName("SA1") + " SA1 ” Local cWhere := “” oCorePanel:SetQuery(cQuery) cWhere := “ SA1.D_E_L_E_T = ‘ ‘ ” oCorePanel:SetWhere(cWhere) |
...
SetPage()
Sintaxe:
CorePanel():SetPage(nPage)
Descrição:
Método que atribui o número da página em que o usuário vai navegar.
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
nPage | Numérico | Número da página que será apresentada para o usuário | 1 |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local nPage := 8
oCorePanel:SetPage(nPage)
|
...
SetPageSize()
Sintaxe:
CorePanel():SetPageSize(nPageSize)
Descrição:
Método que atribui a quantidade máxima de registros que serão exibidos por página.
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
nPageSize | Numérico | Quantidade máxima de registros apresentados por página para o usuário. | 10 |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local nPageSize := 20
oCorePanel:SetPageSize(nPageSize)
|
...
DefFields()
Sintaxe:
CorePanel():DefFields(lConvProt, cField)
Descrição:
Método que efetua a conversão entre campos do Objeto e Protheus
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
lConvProt | Lógico | Define se deve converter os campos para padrão Protheus | .T. | ||
cField | Caracteres | Campo que será convertido |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
oCorePanel:DefFields(.T.,"CAMPO") |
...
GetDataType()
Sintaxe:
CorePanel():GetDataType(lConvProt, cField)
Descrição:
Retorna o tipo do dado de um determinado campo.
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
lConvProt | Lógico | Define se deve converter os campos para padrão Protheus | .T. | ||
cField | Caracteres | Campo que será convertido |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local dData
If oCorePanel:GetDataType(.T.,"CAMPO") == "D"
dData := Date()
Endif |
...
SetFieldsFilt()
Sintaxe:
CorePanel():SetFieldsFilt(cFields)
Descrição:
Método que define quais campos serão retornados pelo serviço.
Parâmetros:
Nome | Tipo | Descrição | Default | Obrigatório | Referência |
---|---|---|---|---|---|
cFields | Caracteres | Campos que serão retornados no JSON. | X |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local cFields := "order, totValue, product"
oCorePanel:SetFieldsFilt(cFields) |
...
ToObjectJson()
Sintaxe:
CorePanel():ToObjectJson()
Descrição:
Método que retorna o JSON serializado.
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local lRet := .T.
Local cError := “Erro na requisição”
If lRet
Self:SetResponse( oCorePanel:ToObjectJson())
Else
cError := oCorePanel:GetJsonError()
SetRestFault( 500, EncodeUtf8(cError) )
EndIf |
...
ToSingleObject()
Sintaxe:
CorePanel():ToSingleObject()
Descrição:
Método que retorna um JSON serializado para apenas um objeto.
Utilizado em consultas (GET) que retornam informações de apenas um registro.
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Local oCorePanel := CorePanel():New()
Local lRet := .T.
Local cError := “Erro na requisição”
If lRet
Self:SetResponse(oCorePanel:ToSingleObject())
Else
cError := oCorePanel:GetJsonError()
SetRestFault( 500, EncodeUtf8(cError) )
EndIf |
...