Histórico da Página
Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi00875.p |
Considerações Gerais
Objetivo
Esta BO tem como objetivo a manipulação dos dados referentes a tabela item-loja (Item da Loja Virtual).
...
A variável denominada h-bodi00875 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-loja | Entrada/Saída | ||||
Item da Loja Virtual | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-estabel | character | x(05) | Código do Estabelecimento | Sim |
|
it-codigo | character | x(16) | Código do Item | Sim |
|
cdn-sequencia | integer | >>>>9 | Sequencia do item | Não | |
log-envdo | logical | Sim/Não | Enviado para Loja? | 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 <character>). | |
Descrição | Retorna valor do campo do índice itemloja_id2 | |
Parâmetros | Descrição | |
| pcod-estabel | Código do Estabelecimento |
pit-codigo | Código do Item | |
Retorno | A BO irá retornar o valor contido no campo código estabelecimento e código do item 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 itemloja_id2 | |
Parâmetros | Descrição | |
| pcod-estabel | Código do Estabelecimento |
pit-codigo | Código do Item | |
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 |
|
openQueryByItemLoja | ||
Requisito | Nenhum | |
Sintaxe | run openQueryByItemLoja in h-handle (input “ByItemLoja”). | |
Descrição | Faz a abertura da tabela principal por estabelecimento. | |
Parâmetros | Descrição | |
N/A | N/A | |
Retorno | N/A |
setConstraintByItemLoja | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintByItemLoja in h-handle (input <character>). | |
Descrição | Seta as restrições para abertura da query por estabelecimento. | |
Parâmetros | Descrição | |
pcod-estabel | Código do Estabelecimento | |
Retorno | N/A |
deleteItensLoja | |||
Requisito | Nenhum | ||
Sintaxe | run deleteItensLoja in h-handle (input <character>, input <character>). | ||
Descrição | Elimina os itens da loja por estabelecimento e família comercial | ||
Parâmetros | Descrição | ||
pcod-estabel | Código do estabelecimento | ||
pfm-cod-com | Código da família comercial | ||
Retorno | N/A |
deleteItemLoja | ||||
Requisito | Nenhum | |||
Sintaxe | run deleteItemLoja in h-handle (input <character>, input <character>). | |||
Descrição | Elimina o item da loja solicitado por estabelecimento e código do item | |||
Parâmetros | Descrição | |||
pcod-estabel | Código do Estabelecimento | |||
pit-codigo | Código do Item | |||
Retorno | N/A |
...
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 |