Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicodibo/bodi00872.p

 

Considerações Gerais

 

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela depto-loja (Departamento Loja).

 

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/bodi00872.p PERSISTENT SET h-bodi00872.

A variável denominada h-bodi00872 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-depto-loja

Entrada/Saída

Departamento Loja

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

fm-cod-com

character

x(8)

Família Comercial

Sim

 

cod-estabel

character

x(5)

Estabelecimento

Sim

 

nom-depto

character

x(30)

Nome Departamento

Não

 

dsl-depto

character

x(15000)

Descrição Departamento

Não

 

cdn-erp

integer

>>>>>>>9

ID ERP

Não

 

cdn-sequencia

integer

>>>9

Sequencia

Não

 

 cdn-loja integer >>>>>9ID LojaNão 
 des-url character x(80)URLNão 
 des-resourcecharacter x(80)ResourceNão 
cod-livre-1characterx(100)Livre 1Não 
cod-livre-2characterx(500)Livre 2Não 
log-livre-1logicalSim/NãoLivre 1Não 
log-livre-2logicalSim/NãoLivre 2Não 
num-livre-1integer>>>>>>>>9Livre 1Não 
num-livre-2integer>>>>>>>>9Livre 2Não 
val-livre-1decimal->>>>>>>>>>>9.99999999Livre 1Não 
val-livre-2decimal->>>>>>>>>>>9.99999999Livre 2Não 
dat-livre-1date99/99/9999Livre 1Não 
dat-livre-2date99/99/9999Livre 2Nã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 dptlj_id2

Parâmetros

Descrição

 

pcod-estabel

Código do Estabelecimento

 pfm-cod-comCódigo da Família Comercial

Retorno

A BO irá retornar o valor contido no campo estabelecimento e família comercial 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 dptlj_id2

Parâmetros

Descrição

 

pcod-estabel

Código do Estabelecimento

 pfm-cod-comCódigo da Família Comercial

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

 N/A

N/A

Retorno

N/A

 

openQueryParamIntegrLoja

Requisito

Nenhum

Sintaxe

run openQueryParamIntegrLoja in h-handle (input “ParamIntegrLoja”).

Descrição

Faz a abertura da tabela principal por estabelecimento.

Parâmetros

Descrição

 N/A

N/A

Retorno

N/A

 

linkToparam-integr-loja

Requisito

Nenhum

Sintaxe

run linkToparam-integr-loja in h-handle (input <handle>).

Descrição

Seta as restrições para abertura da query por Estabelecimento.

Parâmetros

Descrição

pHandle  

handle da tabela pai   

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 caracter 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

 

 

getChild

Requisito

Nenhum

Sintaxe

run getChild in h-handle (INPUT <character>,

                                        INPUT <character> ).

Descrição

Método recursivo para criar a estrutura filha da família comercial pai

Parâmetros

Descrição

pcod-estabel

Código do estabelecimento

p-cod-fm-comCódigo da família comercial

Retorno

N/A

 

beforeCreateRecord

Requisito

Nenhum

Sintaxe

run beforeCreateRecord in h-handle.

Descrição

Busca a próxima sequência do sequence seq-depto-loja

Parâmetros

 N/A

Retorno

N/A

 

deleteChild

Requisito

Nenhum

Sintaxe

run deleteChild in h-handle (INPUT <character>,

                                             INPUT <character> ).

Descrição

Método recursivo para criar a estrutura filha da família comercial pai

ParâmetrosDescrição
pcod-estabelCódigo do estabelecimento
p-cod-fm-comCódigo da família comercial

Retorno

N/A

 

 

createDeptoByRange

Requisito

Nenhum

Sintaxe

RUN createDeptoByRange IN h-handle (INPUT <character>,

                                                               INPUT <character>,

                                                               INPUT <character>).

Descrição

Realiza a criação de departamento por estabelecimento

Parâmetros

Descrição

 

pcod-estabel

Código do Estabelecimento
 pcod-estabel-iniCódigo do Estabelecimento Inicial
 

pcod-estabel-fim

Código do Estabelecimento Final

Retorno

N/A