Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmapi\apiCrmCalcRangFreq.p

 

Objetivo

Calcular o período de freqüência base de calculo do PRFV.

 

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

ttFreqRange

 

Atributo

Tipo

Formato

        Descrição

Obr.

val_freq

Dec

 

Valor da freqüência

 

dt_inic

Date

99/99/9999

Data inicial

 

dt_fim

Date

99/99/9999

Data final

 

tip_per

Int

 

Tipo do período

 

 

Parâmetros de input e output da api

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-periodo

Int

 

X

 

 

Período 1 - semana, 2 - quinzenal, 3 - mensal, 4 - bimestral, 5 - trimestral, 6 - semestral, 7 - anual

dt_per_pos

Date

99/99/9999

X

 

 

Data posterior

i-qtd_sema

Int

 

X

 

 

Quantidade de semanas

coOccurrence

Char

 

X

 

 

Id da ocorrência

ttFreqRange

Tt

 

 

X

 

Relação com os intervalos a serem considerados

 

Métodos

Métodos básicos

 

Método: CheckDateBeginEnd

Descrição: Verifica e corrigi data incial e final do range.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: CreateTtFreqRangeWeekday

Descrição: Calcula intervalo em semanas.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

i-qtd_sema

Int

 

x

 

 

Quantidade de semanas

 

Método: CreateTtFreqRangeFortnight

Descrição: Calcula intervalo quinzenal.

 Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: CreateTtFreqRangeMonth

Descrição: Calcula intervalo mensal.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: CreateTtFreqRangeTwoMonths

Descrição: Calcula intervalo bimestral.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: CreateTtFreqRangeQuarter

Descrição: Calcula intervalo trimestral.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: CreateTtFreqRangeSemester

Descrição: Calcula intervalo semestral.       

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: CreateTtFreqRangeYear

Descrição: Calcula intervalo anual.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

 

Método: checkCountWeekday

Descrição: Calcula quantidade de semanas por período.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

dt-inic

Date

 

x

 

 

Data inicial

i-qtd_sema

Int

 

X

 

 

Quantidade de semanas

i-qtdSemanas

Int

 

X

 

 

Quantidade de semanas

dt-fim_retorno

Date

 

 

X

 

Data final