Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoinbo/boin725.p

 

RecordSet 

 

tt-custo-conta

tt-custo-conta

Atributo

Tipo

Formato

Descrição

Obr.

Ep-codigo

Int

>>9

Código empresa

Sim

Ct-codigo

Char

x(8)

Conta

Sim

Sc-codigo

char      

x(8)

Subconta

Sim

cc-codigo

char      

x(8)

Código centro custo

Sim

Especie

Int

9

Código espécie de custos

Sim 

Percentual

Dec

>>9.99

Percentual da conta

Sim

 char-1           

char     

x(100)

             ?                     

 

 char-2           

char     

x(100)

             ?                     

 

 dec-1            

deci-2   

->>>>>>>>>>>9.9

             ?                      

 

 dec-2            

deci-2   

->>>>>>>>>>>9.9

             ?                     

 

 int-1            

inte     

->>>>>>>>>9   

             ?                     

 

 int-2            

inte     

->>>>>>>>>9   

             ?                      

 

 log-1            

logi     

Sim/Não       

             ?                     

 

 log-2            

logi     

Sim/Não       

             ?                     

 

 data-1           

date     

99/99/9999    

             ?                      

 

 data-2           

date     

99/99/9999    

             ?                     

 

 check-sum        

char     

x(20)

Check-sum             

 

 

RecordSet  Related    

 

Temp-Tables adicionais utilizadas nos demais métodos de negócio para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.

                               

 

Atributo

Tipo

Formato

Descrição

Obr.

 

 

 

 

 

 

Métodos Básicos 

 

Métodos básicos de acesso ao banco de dados.



Método:

goToKey

 

Descrição:  

Reposiciona registro com base no índice.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pep-codigo

Int

 

X

 

 

Código da empresa

pct-codigo

Char

 

X

 

 

Código da conta

psc-codigo

Char

 

X

 

 

Código da subconta

pcc-codigo

Char

 

X

 

 

Código do centro custo

Pespecie

Int

 

X

 

 

Código da espécie de conta

 


Método:

getKey

 

Descrição:  

Retorna valores dos campos do índice.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pep-codigo

Int

 

 

X

 

Código da empresa

pct-codigo

Char

 

 

X

 

Código da conta

psc-codigo

Char

 

 

X

 

Código da subconta

pcc-codigo

Char

 

 

X

 

Código do centro custo

Pespecie

Int

 

 

X

 

Código da espécie de conta

 


Método:

validateRecord

 

Descrição: 

Valida temptable RowObject

 

Requisitos:

Nenhum

 

Parâmetros:

Recebe o tipo de validação (Create, Delete, Update)

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pType

char

 

X

 

 

Recebe o tipo de validação

 

 

Método:

getCharField

 

Descrição:

Retorna o valor de um campo character.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

char

 

 

X

 

Valor Campo

 


Método:

getDecField

 

Descrição:

Retorna o valor de um campo decimal.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PfieldName

Char

 

X

 

 

Nome Campo

PfieldValue

Decimal

 

 

X

 

Valor Campo

 

 

Método:

getIntField

 

Descrição:

Retorna o valor de um campo inteiro.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PFieldName

Char

 

X

 

 

Nome Campo

PfieldValue

Integer

 

 

X

 

Valor Campo



Método:

getDateField

 

Descrição:

Retorna o valor de um campo date.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PfieldName

Char

 

X

 

 

Nome Campo

PfieldValue

Date

 

 

X

 

Valor Campo

 

 

Método:

getLogField

 

Descrição:

Retorna o valor de um campo logical.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PFieldName

char

 

X

 

 

Nome Campo

PFieldValue

logical

 

 

X

 

Valor Campo

 


Método:

getRawField

 

Descrição:

Retorna valor de campos do tipo raw.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PfieldName

char

 

X

 

 

Nome Campo

PfieldValue

raw

 

 

X

 

Valor Campo

 

 

Método:

getRecidField

 

Descrição:

Retorna valor de campos do tipo recid.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PfieldName

char

 

X

 

 

Nome Campo

PfieldValue

recid

 

 

X

 

Valor Campo

 

Queries e Constraints

 

Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura)  utilizadas para buscar grupos de registros da base de dados.

 


Método:

OpenQueryStatic ("Main")

 

Descrição:

Busca conjunto de registros da tabela custo-conta.

 

 

Método:

OpenQueryStatic ("Centro-Custo")

 

Descrição:

Busca conjunto de registros da tabela custo-conta conforme centro de custo.

 

Constraints Associados:

Executar o método linkToCentro-Custo

 

 

Método:

OpenQueryStatic ("FaixaCC")

 

Descrição:

Busca conjunto de registros da tabela centro-custo dentro de uma faixa de centro de custo inicial e final.

 

Constraints Associados:

Executar o método setConstraintFaixaCC

                             SetConstraintCusto-Conta

 

 

Método:

SetConstraintCusto-Conta

 

Descrição:

Seta as variáveis de controle para queries contendo o centro de custo.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cc-codigo

char

 

X

 

 

Centro de Custo

 


Método:

SetConstraintFaixaCC

 

Descrição:

Seta as variáveis de controle para queries contendo o código do centro de custo inicial e final.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cc-codigo-ini

char

 

X

 

 

Código Centro Custo Inicial

p-cc-codigo-fim

char

 

X

 

 

Código Centro Custo Final

 


Método:

LinkToCentro-Custo

 

Descrição:

Seta o handle de uma DBO para comunicação. Roda o método setConstraintCentro-Custo. 


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pHandle

Handle

 

X

 

 

Handle da DBO Comunicação

 

Métodos Negócio 

 

Métodos adicionais de atualização e acesso a base de dados.

 

 

Método:

findPercent

 

Descrição:

Procura por percentuais na tabela custo-conta conforme a conta-contábil.

 

Requisitos:


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PcConta

Char

 

X

 

 

Código da conta

PcSubConta

Char

 

X

 

 

Código da sub-conta

PdPercent

Dec

 

 

X

 

Percentual restante

 

 

Método:

findPercentUp

 

Descrição:

Procura por percentuais na tabela custo-conta conforme a conta-contábil para alteração de registro.

 

Requisitos:


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PrTable

Rowid

 

X

 

 

Rowid da tabela Custo-conta

PcConta

Char

 

X

 

 

Código da conta

PcSubConta

Char

 

X

 

 

Código da sub-conta

PdPercent

Dec

 

 

X

 

Percentual restante

 


Método:

Pi-SetEspecie

 

Descrição:

Seta a espécie para métodos de openQuery e setConstraint.

 

Requisitos:


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

PiEspecie

Int

 

X

 

 

Código da espécie