Árvore de páginas

Versões comparadas

Chave

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

...

---------------------
CLASSE: CustomActions - Purpose: Customizações de Ações da Página e da Tabela
---------------------

MétodoDescriçãoExemplo
setAction(pCodAction, pCodValue)

...


Parameters:
- pCodAction (CHARACTER): Código da Action
- pCodValue: Valor da Action, usar uma das opções:
  - pCodURL (CHARACTER): Valor da URL a ser executada pela Action
  - pCodValue (LOGICAL): Valor da Action
Retorno (LOGICAL): Indicativo se foi possível incluir/alterar a Action

...

 - Purpose:

...

Inclui ou Altera uma Action Padrão
getActionCharacter(pCodAction)
getActionLogical(pCodAction)
Parameters:
- pCodAction (CHARACTER): Código da Action
Retorno (CHARACTER,LOGICAL): Valor da Action

...

 - Purpose:

...

Retorna o valor de uma Action Padrão
removeAction(pCodAction)
Parameters:
- pCodAction (CHARACTER): Código da Action
Retorno (LOGICAL): Indicativo se foi possível remover a Action
 - Purpose: Remove uma Action Padrão
getActions()
Retorno (JsonObject): Actions padrões
 - Purpose: retorna um JsonObject que representa as Actions Padrão

...


setPageCustomActionProperty(pIdAction, pCodProperty, pCodValue)

...


Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
- pCodProperty (CHARACTER): Propriedade que deve ser alterada
- pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor
Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade

...

 - Purpose: Altera uma propriedade de uma Action Customizada de

...

Página 
getPageCustomActionPropertyCharacter(pIdAction, pCodProperty)
getPageCustomActionPropertyInteger(pIdAction, pCodProperty)
getPageCustomActionPropertyDecimal(pIdAction, pCodProperty)
getPageCustomActionPropertyLogical(pIdAction, pCodProperty)
Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
- pCodProperty (CHARACTER): Propriedade
Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade

...

 - Purpose: Retorna

...

o valor de uma propriedade de uma Action Customizada de

...

Página
getPageCustomAction(pIdAction) 
Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
Retorno (JsonObject): Uma Action Customizada de Página
 - Purpose: Retorna um JsonObject que representa uma Action Customizada de Página
addPageCustomAction(pNumType, pCodLabel, pCodAddress [, pCodIcon])

...


Parameters:
- pNumType: Tipo da Action, usar uma das opções: 
  - CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd
  - CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL)
- pCodLabel (CHARACTER): Label da Action
- pCodAddress (CHARACTER): Endereço da Action que será executada
- pCodIcon (CHARACTER): Ícone da Action
Retorno (JsonObject): Action Customizada de Página Incluída

...

 - Purpose:

...

Incluir uma nova Action Customizada

...

na Página
removePageCustomAction(pIdAction)
Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
Retorno (LOGICAL): Indicativo se foi posssível remover a

...

Action - Purpose: Remove uma Action Customizada de Página
getPageCustomActions()
Retorno (JsonArray): Actions Customizadas de Página
 - Purpose: Retorna a lista de

...

Actions Customizadas de Página
setTableCustomActionProperty(pIdAction, pCodProperty , pCodValue)

...


Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
- pCodProperty (CHARACTER): Propriedade que deve ser alterada
- pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor
Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade

...

 - Purpose:

...

Altera uma propriedade de uma Action Customizada de

...

Tabela 
getTableCustomActionPropertyCharacter(pIdAction, pCodProperty)
getTableCustomActionPropertyInteger(pIdAction, pCodProperty)
getTableCustomActionPropertyDecimal(pIdAction, pCodProperty)
getTableCustomActionPropertyLogical(pIdAction, pCodProperty)
Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
- pCodProperty: Propriedade
Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade

...

 - Purpose: Retorna

...

o valor de uma propriedade de uma Action Customizada de

...

Tabela
getTableCustomAction(pIdAction)
Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
Retorno (JsonObject)

...

: Uma Action Customizada de Tabela - Purpose: Retorna um JsonObject que representa uma Action Customizada de

...

Tabela 
addTableCustomAction(pNumType, pCodLabel, pCodAddress [, pCodIcon] [, pConcatKeys])

...


Parameters:
- pNumType: Tipo da Action, usar uma das opções: 
  - CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd
  - CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL)
- pCodLabel (CHARACTER): Label da Action
- pCodAddress (CHARACTER): Endereço da Action que será executada
- pCodIcon (CHARACTER): Ícone da Action
- pConcatKeys (LOGICAL): Indica se deve ser acrescentada a propriedade "concatKeys" na Action
Retorno (JsonObject): Action Customizada de Tabela Incluída

...

 - Purpose:

...

Incluir uma nova Action Customizada

...

na Tabela
removeTableCustomAction(pIdAction)
Parameters:
- pIdAction: Identificador da Action, usar uma das opções:
  - pCodLabel (CHARACTER): Label da Action
  - pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions
Retorno (LOGICAL): Indicativo se foi posssível remover a Action

...

 - Purpose:

...

Remove uma Action Customizada de Tabela
getTableCustomActions()
Retorno (JsonArray): Actions Customizadas de Tabela
 - Purpose: Retorna a lista de Actions Customizadas de Tabela
getServerAddress(pIsExt)

...


Parameters:
- pIsExt (LOGICAL): Indica se deve ser considerado o Endereço Exerno (Valor: TRUE) ou Interno (Valor:FALSE). Se for solicitado o Externo e ele não existir, será devolvido o interno
Retorno (CHARACTER): Endereço no formato: http://HOST:PORT
 - Purpose: Retorna o Endereço onde o Datasul está hospedado





--------------------
CLASSE: CustomRecord - Purpose: Customizações de Registros
--------------------

...