Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Método que atribui o número da página em que o usuário vai navegar.

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
nPageNuméricoNúmero da página que será apresentada para o usuário1

Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel := CorePanel():New()
Local nPage 	 := 8 

oCorePanel:SetPage(nPage)

...

Método que atribui a quantidade máxima de registros que serão exibidos por página.

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
nPageSizeNuméricoQuantidade máxima de registros apresentados por página para o usuário.10

Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel := CorePanel():New()
Local nPageSize	 := 20

oCorePanel:SetPageSize(nPageSize)

...

Método que efetua a conversão entre campos do Objeto e Protheus

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
lConvProtLógicoDefine se deve converter os campos para padrão Protheus.T.

cFieldCaracteresCampo que será convertido


Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel := CorePanel():New()

oCorePanel:DefFields(.T.,"CAMPO")

...

Retorna o tipo do dado de um determinado campo.

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
lConvProtLógicoDefine se deve converter os campos para padrão Protheus.T.

cFieldCaracteresCampo que será convertido


Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel := CorePanel():New()
Local dData

If oCorePanel:GetDataType(.T.,"CAMPO") == "D"
	dData := Date()
Endif

...

Método que define quais campos serão retornados pelo serviço.

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
cFieldsCaracteresCampos que serão retornados no JSON.
X
Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel := CorePanel():New()
Local cFields 	 := "order, totValue, product"

oCorePanel:SetFieldsFilt(cFields) 

...

Método que retorna um JSON serializado para apenas um objeto.

Utilizado em consultas (requisições do tipo GET ) que retornam informações de apenas um registro.

Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
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 


...

GetJsonObject()

Sintaxe:

CorePanel():GetJsonObject()

Descrição:

Método que retorna o objeto JSON da classe

Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel := CorePanel():New()
Local oJson

oJson:= oCorePanel:GetJsonObject()

If oJson['items'] != Nil
	...
Endif


...

SetApiQstring()

Sintaxe:

CorePanel():SetApiQstring(aQueryString)

Descrição:

Método que define os campos (Retornados pelo Json), page (página que será apresentada) e pagesize (Quantidade máxima de registros por página) e filtros.

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
aQueryStringArrayRecebe o filtro a ser utilizado quando retornado o Json


Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel 	:= CorePanel():New()
Local aQueryString 	:= {} 

aAdd(aQueryString, {“fields”	, “order, totValue”	}) 
aAdd(aQueryString, {“page”		, 10				}) 
aAdd(aQueryString, {“pagesize”	, 5					}) 

oCorePanel:SetApiQString(aQueryString) 


...

SetApiFilter()

Sintaxe:

CorePanel():SetApiFilter(aFilter)

Descrição:

Método que atribui um filtro de pesquisa.

Parâmetros:

NomeTipoDescriçãoDefaultObrigatórioReferência
aFilterArrayArray com expressões de filtro que serão utilizadas
X
Bloco de código
languagec#
themeEclipse
titleExemplo de utilização
linenumberstrue
collapsetrue
Local oCorePanel 	:= CorePanel():New()
Local aFilter		:= {} 

aAdd(aFilter, {“A1_COD = '000001'”}) 

oCorePanel:SetApiFilter(aFilter)