Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

adbo/boad107se.p

Considerações Gerais

 

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela estabelec (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 é:

 

RUN adbo/boad107se.p PERSISTENT SET h-boad107se.

 

A variável denominada h-boad107se 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-estabelec

Entrada/Saída

Estabelecimento

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-estabel

character

x(05)

Estabelecimento de Atendimento

Sim

 

nome

character

x(40)

Nome

Sim

 

endereco

character

x(60)

Endereço

Sim

 

bairro

character

x(60)

Bairro

Sim

 

cidade

character

x(25)

Cidade

Sim

 

estado

character

x(04)

Estado

Sim

 

      cepinteger99999,999CEPNão 
      paíscharacterx(20)PaísNão 
      cgccharacterx(19)CGCNão 
ins-estadualcharacterx(19)Inscrição EstadualNão 
deposito-cqcharacterx(03)DepósitoNão 
    ct-icmcharacterx(20) Não 
    sc-icmcharacterx(20) Não 
     ct-ipicharacterx(20) Não 

     sc-ipi 

characterx(20) Não 
     ct-isscharacterx(20) Não 
    sc-isscharacterx(20) Não 

cod-emitente

integer>>>>>>>>9 Não 
  ct-despesacharacterx(20) Não 
 sc-despesacharacterx(20) Não 
   ct-creditocharacterx(20) Não 
   sc-creditocharacterx(20) Não 
ct-icms-compcharacterx(20) Não 
sc-icms-compcharacterx(20) Não 
      seriecharacterx(05) Não 
ct-ir-retcharacterx(20) Não 
sc-ir-retcharacterx(20) Não 
ct-icmsub-ftcharacterx(20) Não 
sc-icmsub-ftcharacterx(20) Não 
ct-iss-ftcharacterx(20) Não 
sc-iss-ftcharacterx(20) Não 
ct-icms-ftcharacterx(20) Não 

sc-icms-ft

characterx(20) Não 
ct-ipi-ftcharacterx(20) Não 

sc-ipi-ft

characterx(20) Não 
ct-pischaracterx(20) Não 

sc-pis

characterx(20) Não 
ct-finsoccharacterx(20) Não 

sc-finsoc

characterx(20) Não 
ct-pis-pgcharacterx(20) Não 
sc-pis-pgcharacterx(20) Não 
ct-fins-pgcharacterx(20) Não 
sc-fins-pgcharacterx(20) Não 
permissaocharacterx(72) Não 

dep-rej-cq

characterx(03) Não 
ct-ext-icmscharacterx(20) Não 
sc-ext-icmscharacterx(20) Não 
ct-ext-ipicharacterx(20) Não 
sc-ext-ipicharacterx(20) Não 
ins-municipalcharacterx(19) Não 
ct-cofins-ftcharacterx(20) Não 
sc-cofins-ftcharacterx(20) Não 
cod-suframacharacterx(20) Não 
serie-manualcharacterx(05) Não 
sc-icms-devcharacterx(20) Não 
sc-ipi-devcharacterx(20) Não 
ct-ipi-devcharacterx(20) Não 
ct-icms-devcharacterx(20) Não 
ct-equaliz-reccharacterx(20) Não 
sc-equaliz-reccharacterx(20) Não 
ct-equaliz-despcharacterx(20) Não 
sc-equaliz-despcharacterx(20) Não 
zip-codcharacterx(12) Não 
cd-calencharacterx(09) Não 
medio-atedate99/99/9999 Não 
ep-codigocharacterx(03) Não 

ct-desp-iof

characterx(20) Não 
ct-desp-juroscharacterx(20) Não 
ct-desp-juros-avccharacterx(20) Não 
sc-desp-iofcharacterx(20) Não 
sc-desp-juroscharacterx(20) Não 
sc-desp-juros-avccharacterx(20) Não 
dt-vcto-irrfdate99/99/9999 Não 
dt-vcto-issdate99/99/9999 Não 
dt-vcto-icmsdate99/99/9999 Não 
dt-vcto-ipidate99/99/9999 Não 
dt-vcto-cofinsdate99/99/9999 Não 
dt-vcto-pisdate99/99/9999 Não 
grupo-alocacharacterx(05) Não 
conta-creditocharacterx(17) Não 
conta-despesascharacterx(17) Não 
conta-cofinscharacterx(17) Não 
conta-desp-iofcharacterx(17) Não 
conta-juros-pagoscharacterx(17) Não 
conta-desp-equalizcharacterx(17) Não 
conta-rec-equalizcharacterx(17) Não 
conta-extorno-icmscharacterx(17) Não 
conta-extorno-ipicharacterx(17) Não 
conta-fin-pagcharacterx(17) Não 
conta-desp-fincharacterx(17) Não 
conta-icmscharacterx(17) Não 
conta-icms-compcharacterx(17) Não 
conta-dev-icmscharacterx(17) Não 
conta-desp-icmscharacterx(17) Não 
conta-icms-retcharacterx(17) Não 
conta-ipicharacterx(17) Não 
conta-dev-ipicharacterx(17) Não 
conta-ipi-fatcharacterx(17) Não 
conta-ir-retcharacterx(17) Não 
conta-isscharacterx(17) Não 
conta-desp-isscharacterx(17) Não 
conta-pis-reccharacterx(17) Não 
conta-pis-pagcharacterx(17) 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 <decimal>).

Descrição

Retorna valor do campo do índice ordpeso_id2

Parâmetros

Descrição

 

pcdd-ord-peso

Ordem de Pesagem

Retorno

A BO irá retornar o valor contido no campo ordem de pesagem que foi solicitado a BO.

goToKey

Requisito

Nenhum

Sintaxe

RUN goToKey IN h-handle (INPUT <decimal>).

Descrição

Reposiciona registro com base no índice ordpeso_id2

Parâmetros

Descrição

 

pcdd-ord-peso

Ordem de Pesagem

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

 

 

 

openQueryByIdiRelac

Requisito

Nenhum

Sintaxe

run openQueryByIdiRelac in h-handle (input “ByIdiRelac”).

Descrição

Faz a abertura da tabela principal por sequência.

Parâmetros

Descrição

 

 

Retorno

 

 

 

setConstraintByIdiRelac

Requisito

Nenhum

Sintaxe

run setConstraintByIdRelac in h-handle (input <integer>).

Descrição

Seta as restrições para abertura da query por Sequência do Relacionamento do Estabelecimento.

Parâmetros

Descrição

p-idi-relac-estab-atend   

Sequencia do Relacionamento do Estabelecimento     

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