Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmapi\apiCrmCampanha.p

 

Objetivo

Faz algumas buscas, validações e manutenções na tabela de campanha. É usada principalmente nas telas de registro de tarefa e registro de ação.

 

Tabelas Temporárias

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

ttChaveCampanha

 

Atributo

Tipo

Formato

        Descrição

Obr.

numIdCampanha

Int

 

 

 

 

Métodos

Métodos básicos

 

Método: afazerAberto.

Descrição: Informa se há tarefas abertas.           

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

dataFimCampanha

Char

 

X

 

 

Data de finalização da campanha

afazeresAbertos

Char

 

 

X

 

Retorno

 

Método: finalizaTarefas.

Descrição: Finaliza a tarefa passada como parâmetro.           

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

dataFimCampanha

Char

 

X

 

 

Data de finalização da campanha

 

Método: verificaFinalizaCampanha.

Descrição: Verifica se a tarefa passada como parâmetro está aberta.            

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

logFinalizaCampanha

Log

 

X

 

 

Informa status finalizada ou não

tarefasAbertas

Log

 

 

X

 

Retorno

 

Método: verificaAtivaCampanha. 

Descrição: Verifica se a tarefa passada como parâmetro está ativa.             

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

logFinalizaCampanha

Log

 

X

 

 

Informa status finalizada ou não

tarefasSuspensas

Log

 

 

X

 

Retorno

 

Método: finalizaTarOportun.

Descrição: Finaliza a tarefa passada como parâmetro e suspende a oportunidade relacionada com essa tarefa.

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

logFinalizaCampanha

Log

 

X

 

 

 

 

Método: reativaTarOportun.

Descrição: Reativa a tarefa passada como parâmetro e reativa também a oportunidade relacionada com essa tarefa.          

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

 

Método: criaRegistrosAcao.

Descrição: Cria um registro de ação a partir da campanha passada como parâmetro.

Requisitos: Nenhum. 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

numIdCampanha

Char

 

X

 

 

Código seqüencial de campanha

 

Método: loadDataFim.

Descrição: Retorna a data atual.

Requisitos: Nenhum. 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-datafim

Char

 

 

X

 

Retorno

 

Método: carregaCampanhaDeAcordoComUsuario. 

Descrição: Retorna as campanhas que o usuário logado tem acesso.

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

ttChaveCampanha

Temp-table

 

 

X

 

Retorno