Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi095na.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela item-cli (Itens Cliente).
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 execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a BO em modo persistente é:
RUN dibo/bodi095na.p PERSISTENT SET h-bodi095. |
A variável denominada h-bodi095 irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
tt-item-cli | Entrada/Saída | ||||
Registro da mensagem da loja Erro | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
it-codigo | character | x(16) | Código do item | Sim | |
nome-abrev | character | x(12) | Nome Abreviado do Cliente | Sim | |
cod-emitente | integer | >>>>>>>>9 | Código do cliente | Sim | |
vl-maior-com | decimal | >>>,>>>,>>9.99 | Maior valor de compra | Não | |
dt-ult-com | date | 99/99/9999 | Data da última compra | Não | |
vl-ult-com | decimal | >>>,>>>,>>9.99 | Valor da última compra | Não | |
tp-moeda | integer | >9 | Moeda | Não | |
item-do-cli | character | x(30) | Código deste item no cliente | Não | |
unid-med-cli | character | xx | Unidade Medida Cliente | Sim | |
fator-conver | integer | >>>>>>>>9 | Fator de conversão | Sim | |
num-casa-dec | integer | >9 | Número Casas Decimais | Não | |
narrativa | character | x(2000) | Narrativa | Não | |
vl-precon | decimal | >>>,>>>,>>9.99999 | Preço de venda ao consumidor | Sim | |
nr-dias-gar | integer | >,>>9 | Número de dias do prazo de garantia | Sim | |
qt-ult-com | decimal | >>,>>>,>>9.9999 | Quantidade da última compra | Sim | |
qt-mai-com | decimal | >>,>>>,>>9.9999 | Quantidade da maior compra | Sim | |
per-minfat | decimal | >9.99 | Percentual mínimo aceito para faturamento parcial | Sim | |
fat-conver | decimal | >>>>>>>>>9 | Fator de conversão | Sim | |
vl-mai-coml | decimal | >>,>>>,>>>,>>9.99 | Maior valor comercial | Não | |
dt-mai-coml | date | 99/99/9999 | Data do maior valor comercial | Não | |
tp-inspecao | integer | 99 | Tipo de inspeção | Não | |
laudo-no-fat | logical | Sim/Não | Emite laudo técnico no faturamento? | Não | |
tp-adm-lote | integer | 99 | Política de administração do lote | Sim | |
tp-aloc-lote | integer | 99 | Tipo de alocação do lote | Não | |
check-sum | character | x(20) | Check-sum | Não | |
lote-mulven | decimal | >>,>>>,>>9.9999 | Lote Múltiplo de Venda do Item | Sim | |
qtd-dias-prateleira | integer | >>9 | Tempo de prateleira em dias | Sim | |
qtd-dias-transporte | integer | >>9 | Tempo de transporte em dias | Sim | |
log-unid-prefer | logical | Sim/Não | Unidade de Medida Preferencial? | Não | |
ind-sit-relac | integer | 9 | Situação relacionamento. | Não | |
fator-conversao | decimal | >>>>>>>>>>>>>>>>>>>>>>>>>>>>>9 | Fator Conversão | Não | |
char-1 | character | x(100) | Livre 1 | Não | |
char-2 | character | x(100) | Livre 2 | Não | |
dec-1 | decimal | ->>>>>>>>>>>9.99999999 | Livre 1 | Não | |
dec-2 | decimal | ->>>>>>>>>>>9.99999999 | Livre 2 | Não | |
int-1 | integer | ->>>>>>>>9 | Livre 1 | Não | |
int-2 | integer | ->>>>>>>>9 | Livre 2 | Não | |
log-1 | logical | Sim/Não | Livre 1 | Não | |
log-2 | logical | Sim/Não | Livre 2 | Não | |
data-1 | date | 99/99/9999 | Livre 1 | Não | |
data-2 | date | 99/99/9999 | Livre 2 | Não |
Método Básico
getCharField | ||
Requisito | Nenhum | |
Sintaxe | RUN getCharField IN handle (INPUT <character>, OUTPUT <character>). | |
Descrição | Retorna valor dos campos do tipo caracter | |
Parâmetros | Descrição | |
pFieldName | Nome do campo caracter que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo caracter que foi solicitado a BO. |
getDateField | ||
Requisito | Nenhum | |
Sintaxe | RUN getDateField IN handle (INPUT <character>, OUTPUT <date>). | |
Descrição | Retorna valor dos campos do tipo data | |
Parâmetros | Descrição | |
pFieldName | Nome do campo data que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo data que foi solicitado a BO. |
getDecField | ||
Requisito | Nenhum | |
Sintaxe | RUN getDecField IN handle (INPUT <character>, OUTPUT <decimal>). | |
Descrição | Retorna valor dos campos do tipo decimal | |
Parâmetros | Descrição | |
pFieldName | Nome do campo decimal que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo decimal que foi solicitado a BO. |
getIntField | ||
Requisito | Nenhum | |
Sintaxe | RUN getIntField IN handle (INPUT <character>, OUTPUT <integer>). | |
Descrição | Retorna valor dos campos do tipo inteiro | |
Parâmetros | Descrição | |
pFieldName | Nome do campo inteiro que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo inteiro que foi solicitado a BO. |
getLogField | ||
Requisito | Nenhum | |
Sintaxe | RUN getLogField IN handle (INPUT <character>, OUTPUT <logical>). | |
Descrição | Retorna valor dos campos do tipo logico | |
Parâmetros | Descrição | |
pFieldName | Nome do campo logico que será retornado o valor | |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo logico que foi solicitado a BO. |
getRawField | ||
Requisito | Nenhum | |
Sintaxe | RUN getRawField IN handle (INPUT <character>, OUTPUT <raw>). | |
Descrição | Retorna valor dos campos do tipo raw | |
Parâmetros | Descrição | |
| pFieldName | Nome do campo raw que será retornado o valor |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo raw que foi solicitado a BO. |
getRecidField | ||
Requisito | Nenhum | |
Sintaxe | RUN getRecidField IN handle (INPUT <character>, OUTPUT <recid>). | |
Descrição | Retorna valor dos campos do tipo recid | |
Parâmetros | Descrição | |
| pFieldName | Nome do campo recid que será retornado o valor |
| pFieldValue | Valor contido no campo solicitado |
Retorno | A BO irá retornar o valor contido no campo recid que foi solicitado a BO. |
getKey | ||
Requisito | Nenhum | |
Sintaxe | RUN getKey IN handle (OUTPUT <character>, OUTPUT <character>). | |
Descrição | Retorna valor do campo do índice ch-cli-item | |
Parâmetros | Descrição | |
| pItCodigo | Código do Item |
pNomeAbrev | Nome Abreviado Cliente | |
Retorno | A BO irá retornar o valor contido no campo código do item e nome abreviado do cliente que foi solicitado a BO |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>, INPUT <character>). | |
Descrição | Reposiciona registro com base no índice ch-cli-item | |
Parâmetros | Descrição | |
| pItCodigo | Código do Item |
pNomeAbrev | Nome Abreviado Cliente | |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
Métodos de Negócio
OpenQuery / SetConstraint
openQueryMain | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Main":U). | |
Descrição | Faz a abertura da tabela principal. | |
Parâmetros | Descrição | |
| ||
Retorno |
openQueryFaixaItCli | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "FaixaItCli":U). | |
Descrição | Faz a abertura da tabela principal baseado na faixa do item do cliente. | |
Parâmetros | Descrição | |
| ||
Retorno |
openQueryFlex | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Flex":U). | |
Descrição | Faz a abertura da tabela principal baseado em critérios estabelecidos para o Flex. | |
Parâmetros | Descrição | |
| ||
Retorno |
setConstraintFlex | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintFlex in h-handle (input "character", input "character", input "character", input "character", input "character", input "character"). | |
Descrição | Faz a abertura da tabela principal baseado em critérios estabelecidos para o Flex. | |
Parâmetros | Descrição | |
pNomeAbrev | Nome abreviado do cliente | |
pCriteria | Critério para pesquisa | |
pcFamComercial | Família comercial do item | |
pcGrupoEstoq | Grupo de Estoque | |
pcReferencia | Referencia do item | |
pcDescItem | Descrição do item | |
Retorno |
setConstraintFaixaItCli | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintFlex in h-handle (input "character", input "character", input "character"). | |
Descrição | Faz a abertura da tabela principal baseado em critérios estabelecidos para o Flex. | |
Parâmetros | Descrição | |
pcItemCliIni | Código do Item do Cliente | |
pcItemCliFim | Código do Item do Cliente | |
pcNomeAbrev | Nome Abreviado do Cliente | |
Retorno |
validateRecord | ||
Requisito | Nenhum | |
Sintaxe | RUN validateRecord IN h-handle (INPUT <character>). | |
Descrição | Efetua as validações do registro antes de ser gravado na tabela Histórico de Relacionamento do Estabelecimento de Atendimento | |
Parâmetros | Descrição | |
| pType | Parâmetro character para indicar o tipo de gravação do registro (Create, Delete e Update). |
Retorno | “OK” – Registro gravado corretamente “NOK” – Registro inválido, Verificar a lista de erros na temp-table RowErrors |