Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi00755.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela canal-clien-estab (Canal Cliente Estabelecimento).
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 é:
DEFINE VARIABLE h-bodi00755 AS HANDLE NO-UNDO. |
A variável denominada h-bodi00755 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-canal-clien-estab | Entrada/Saída | ||||
Canal Cliente Estabelecimento | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-estabel | character | x(5) | Código do estabelecimento | Sim | |
cod-emitente | integer | >>>>>>>>9 | Código do emitente | Sim | |
nome-abrev | character | x(12) | Nome abreviado | Não | |
cod-cond-pag | integer | >>>9 | Código da condição de pagamento para as Notas Fiscais | Não | |
cod-rep | integer | >>>>9 | Informe o código do representante | Não | |
nr-tabpre | character | x(08) | Código da tabela de preços | Não | |
bonificacao | decimal | >>9.999 | Valor percentual total desconto política descontos | Sim | |
cod-canal-venda | integer | >>9 | Código do canal de vendas | Sim | |
cod-transp | integer | >>,>>9 | Código do transportador | Não | |
dat-fim-validade | date | 99/99/9999 | Data fim validade | Não | |
dat-inic-validade | date | 99/99/9999 | Data inicio validade | Sim | |
val-comis-emis | decimal | >>9.99 | Percentual de Comissão | Não | |
val-perc-comis | decimal | >>9.99 | Informe o percentual de comissão do representante | Não | |
cod-livre-1 | character | x(100) | Livre 1 | Não | |
cod-livre-2 | character | x(500) | Livre 2 | Não | |
log-livre-1 | logical | Sim/Não | Livre 1 | Não | |
log-livre-2 | logical | Sim/Não | Livre 2 | Não | |
num-livre-1 | integer | >>>>>>>>9 | Livre 1 | Não | |
num-livre-2 | integer | >>>>>>>>9 | Livre 2 | Não | |
val-livre-1 | decimal | ->>>>>>>>>>>9.99999999 | Livre 1 | Não | |
val-livre-2 | decimal | ->>>>>>>>>>>9.99999999 | 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 |
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 <integer>, OUTPUT <integer>, OUTPUT <date>). | |
Descrição | Retorna valor do campo do índice cnlclnst_id | |
Parâmetros | Descrição | |
| pcod-estabel | Código do estabelecimento |
pcod-canal-venda | Código do canal de venda | |
pcod-emitente | Código do emitente | |
pdat-inic-validade | Data inicio de validade | |
Retorno | A BO irá retornar o valor contido no campo código estabelecimento, código do canal de venda, código do emitente e data inicio de validade do registro que foi solicitado a BO. |
goToKey | ||
Requisito | Nenhum | |
Sintaxe | RUN goToKey IN h-handle (INPUT <character>, INPUT <integer>, INPUT <integer>, INPUT <date>). | |
Descrição | Reposiciona registro com base no índice cnlclnst_id | |
Parâmetros | Descrição | |
| pcod-estabel | Código do estabelecimento |
pcod-canal-venda | Código do canal de venda | |
pcod-emitente | Código do emitente | |
pdat-inic-validade | Data inicio de validade | |
Retorno | A BO irá reposicionar no registro que foi solicitado a BO. |
Métodos de Negócio
returnCustomerDefault | ||
Requisito | Nenhum | |
Sintaxe | RUN returnCustomerDefault IN h-handle (INPUT <character>, INPUT <character>, OUTPUT <character>, OUTPUT <decimal>, OUTPUT <integer>, OUTPUT <character>, OUTPUT <integer>, OUTPUT <integer>, OUTPUT <decimal>, OUTPUT <decimal>). | |
Descrição | Retorna os dados da canal cliente de acordo com o emitente e canal de venda informados | |
Parâmetros | Descrição | |
| pcod-canal-venda | Código do canal de venda |
pcod-emitente | Código do emitente | |
pbonificacao | Valor percentual total desconto política descontos | |
pcod-cond-pag | Código da condição de pagamento | |
pnr-tabpre | Código da tabela de preço | |
pcod-transp | Código do transportador | |
pcod-rep | Código do representante | |
pval-perc-comis | Informe o percentual de comissão do representante | |
pval-comis-emis | Percentual de Comissão | |
Retorno | A BO irá retornar o valor contido no campo valor percentual total de desconto da política de descontos , código da condição de pagamento, código da tabela de preço, código do transportador, código do representante, percentual de comissão do representante e percentual de comissão do registro que foi solicitado a BO. |
exportDiscountSalesOrder | ||
Requisito | Nenhum | |
Sintaxe | RUN exportDiscountSalesOrder IN h-handle (INPUT <integer>, INPUT <character>, INPUT <integer>, INPUT <date>, INPUT <date>, INPUT <character>, INPUT <character>). | |
Descrição | Atualiza o percentual de desconto do cliente nos pedidos de venda de acordo com as informações passadas para este método | |
Parâmetros | Descrição | |
| pcod-emitente | Código do emitente |
pcod-estabel | Código do estabelecimento | |
pcod-canal-venda | Código do canal de venda | |
pdat-inic-validade | Data inicio da validade | |
pdat-fim-validade | Data fim de validade | |
pbonificacao-ant | Bonificação anterior | |
pbonificacao-nova | Nova bonificação | |
Retorno |
OpenQuery / ValidateRecord
openQueryDefault | ||
Requisito | Nenhum | |
Sintaxe | run openQueryStatic in h-handle (input "Default":U). | |
Descrição | Faz a abertura da tabela principal. | |
Parâmetros | Descrição | |
| ||
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 canal cliente estabelecimento | |
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 |