Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | inbo/boin00886.p |
Considerações Gerais
Objetivo
Manter e fornecer informações sobre as famílias dos itens do clicbusiness, utilizados para o envio e consulta no portal da clicbusiness
Funcionamento
A BO deverá ser sua execução na forma persistente ...
A sintaxe para executar a API/BO em modo persistente é:
run inbo/boin00886.p persistent set h-handle. |
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:
Método Básico
Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
goToKey | ||
Requisito | nenhum | |
Sintaxe | Run goToKey in handle (intpu pcod-cgc Input pcod-familia). | |
Descrição | Reposiciona registro com base no índice da fornec-clicbusiness. | |
Parâmetros | Descrição | |
pcod-cgc | Código do CNPJ do fornecedor | |
pcod-familia | Código da família | |
Retorno | Retorna “NOK” se não conseguir posicionar. |
getKey | ||
Requisito | nenhum | |
Sintaxe | Run getKey in handle (intpu pcod-cgc Input pcod-familia). | |
Descrição | Retorna os valores do índice da familia-clicbusiness. | |
Parâmetros | Descrição | |
pcod-cgc | CNPJ do fornecedor | |
pcod-familia | Código da família | |
Retorno | Retorna “NOK” se o registro não estiver posicionado. |
ValidateRecord | ||
Requisito | nenhum | |
Sintaxe | Run validateRecord in handle (intpu pType). | |
Descrição | Validações pertinentes ao DBO. | |
Parâmetros | Descrição | |
pType | Recebe o tipo de validação | |
Retorno |
|
getCharField | ||
Requisito | nenhum | |
Sintaxe | Run getCharField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo Caracter | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
getDecField | ||
Requisito | nenhum | |
Sintaxe | Run getDecField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo Decimal. | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
getIntField | ||
Requisito | nenhum | |
Sintaxe | Run getIntField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo Inteiro. | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
getDateField | ||
Requisito | nenhum | |
Sintaxe | Run getDateField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo Data. | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
getlogField | ||
Requisito | nenhum | |
Sintaxe | Run getLogField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo Lógico. | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
getRawField | ||
Requisito | nenhum | |
Sintaxe | Run getIntField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo tipo Raw. | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
getRecIdField | ||
Requisito | nenhum | |
Sintaxe | Run getIntField in handle (intpu pFieldname, Output pFieldValue). | |
Descrição | Retorna o valor de um campo do tipo RecId. | |
Parâmetros | Descrição | |
pFieldName | Nome Campo | |
pFieldValue | Valor Campo | |
Retorno |
|
Método Negócio
pi-clearTable | ||
Requisito | nenhum | |
Sintaxe | Run pi-clearTable in handle. | |
Descrição | Eliminar todos os dados da tabela fornec-clicbusiness | |
Parâmetros | Descrição | |
|
| |
Retorno | A BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta).
|
pi-retorna-fornecedores-familia | ||
Requisito | nenhum | |
Sintaxe | Run pi-retorna-fornecedores-familia in handle (intpu table tt-familia, output table tt-fornec-clicbusiness). | |
Descrição | Procedure para a leitura dos dados da tabela fornec-clicbusines a partir da leitura das familias. | |
| Parâmetros | Descrição |
| tt-familia | Temp-table com os códigos das famílias. |
| tt-fornec-clicbusiness | Temp-table com o retorno dos fornecedores por itens. |
Retorno | A BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta). |
OpenQuery / SetConstraint / LinkTo
OpenQueryMain | ||
Requisito | Nenhum | |
Sintaxe | Run openQueryStatic in hendle (“Main”). | |
Descrição | Busca conjunto de registros da tabela família-clicbusiness. | |
Parâmetros | Descrição | |
Nenhum |
| |
Retorno |
|