Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | crmbo/boCrmAcessPortalRegra.p |
Considerações Gerais
Objetivo
Realizar a manutenção de ocorrências.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A sintaxe para a chamada da API/BO é:
run crmbo/bocrmOcor.p (input-output table tt-..., input table tt-..., ..., ...). |
A execução na forma persistente ...
A sintaxe para executar a API/BO em modo persistente é:
run crmbo/bocrmOcor.p persistent set h-handle (input-output table tt-..., input table tt-..., ..., ...). |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
RowObject | Entrada/Saída | ||||
Temp-table espelho da tabela mais o campo r-rowid do tipo rowid | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num_id | Int | 99999999 | ID da tabela | Sim |
|
num_id_acess_form_portal | Int | >>>>,>>9 | ID Formulário | Sim |
|
num_id_acess_portal | Int | >>>>,>>9 | ID Restrição | Sim |
|
num_id_acess_compon | Int | >>>>,>>9 | ID Associação Formulário x Componente | Não |
|
Idi_tip_acess | Int | 9 | Regra (1 Ocultar, 2 Desabilitar) | Sim |
|
Dat_timestamp | Date | 99/99/9999 | Data de Alteração do Registro | Sim |
|
Cdd_version | Dec | >>>,>>>,>>>,>>9 | Versão | Sim |
|
Num_livre_1 | Int | >>>>>9 | Livre 1 | Não |
|
Val_livre_1 | Dec | Zzz,zzz,zz9.9999 | Livre 1 | Não |
|
Val_livre_2 | Dec | Zzz,zzz,zz9.9999 | Livre 2 | Não |
|
Num_livre_2 | Int | >>>>>9 | Livre 2 | Não |
|
Cod_livre_1 | Char | X(100) | Livre 1 | Não |
|
Cod_livre_2 | Char | X(100) | Livre 2 | Não |
|
Dat_livre_1 | Date | 99/99/9999 | Livre 1 | Não |
|
Dat_livre_2 | Date | 99/99/9999 | Livre 2 | Não |
|
Log_livre_1 | Log | Sim/Não | Regra Formulário Geral? | Não |
|
Log_livre_2 | Log | Sim/Não | Livre 2 | Não |
|
Método Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
goToKey | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
Descrição | Reposiciona registro com base no índice CODIGO | |
Parâmetros | Descrição | |
NUM_ID | Código indentificador sequencial. | |
Retorno |
|
getKey | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
Descrição | Retorna valores dos campos chave do índice CODIGO. | |
Parâmetros | Descrição | |
NUM_ID | Código indentificador sequencial. | |
Retorno |
|
validateRecord | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
Descrição | Validações pertinentes ao DBO para as operações de Create, Update e Delete. | |
Parâmetros | Descrição | |
pType | Recebe o tipo de validação (Create, Delete, Update) | |
Retorno |
|
getCharField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo character. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
getDecField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo decimal. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
getIntField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo inteiro. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
getDateField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo date. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
getLogField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo logical. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
getRawField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo raw. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
getRecidField | ||
Requisito | Nenhum | |
Sintaxe | [nome_método] (input ..., output ..., ..., ...) | |
| Retorna o valor de um campo recid. | |
Parâmetros | Descrição | |
pFieldName | pFieldName | |
pFieldValue | Valor Campo | |
Retorno |
|
Método Negócio
assignNumId | ||
Requisito |
| |
Sintaxe | Run assignNumId in h-handle. | |
Descrição | Popula o campo ID com valor único sempre que a operação for do tipo create | |
Parâmetros | Descrição | |
|
| |
Retorno |
|
showCurrentUser | ||
Requisito |
| |
Sintaxe | Run showCurrentUser in h-handle (output i-user). | |
Descrição | Retorna o ID do usuário do CRM logado. | |
Parâmetros | Descrição | |
|
| |
Retorno | i-user - integer |
OpenQuery / SetConstraint / LinkTo
openQueryDefault | ||
Requisito | Nenhum | |
Sintaxe | RUN openQueryStatic IN h-handle (INPUT "Default"). | |
Descrição | Abertura da Query da Tabela | |
Parâmetros | Descrição | |
|
| |
|
| |
Retorno |
|
setConstraint<xxx> | ||
Requisito | Nenhum | |
Sintaxe | run setConstraint<xxx> in h-handle (input <integer>, input <character>). | |
Descrição | Seta as restrições para abertura da query por <xxx> | |
Parâmetros | Descrição | |
Param1 | Descrição param1 | |
Param2 | Descrição param2 | |
Retorno |
|