Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

crmboCustom\boCrmPessoaCustomPF.p

 

Objetivo

Customizar a Pessoa Física.

 

Tabelas Temporárias

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

tt-cta_usuar

 

Atributo

Tipo

Formato

        Descrição

Obr.

cod_pessoa_erp

Char

 

Código no ERP

 

num_id_pessoa

Int

 

Código no CRM

 

 

Métodos Básicos

 

Método: afterAllSelectedRecords

Descrição: Tem por objetivo ser executada após todos os registros (apenas os registros da página corrente) terem sido lidos para que o usuário possa realizar customizações em registros específicos (navegar para um determinado registro, alterar informação de um registro com base no valor de outro, etc).

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tableName

Char

 

X

 

 

Nome da tabela em questão

ttDataset

Handle

 

 

 

X

Handle da temp-table do dataset

 

Método: afterPersistRecord

Descrição: Tem por objetivo ser executada após ter realizado qualquer tipo de persistência (CREATE, UPDATE e DELETE) para que possa ser realizado customizações após a realização da persistência e/ou correções na RowErrors.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pType

Char

 

X

 

 

“CREATE”, “UPDATE” ou “DELETE”

ttDataset

Handle

 

 

 

X

Handle da temp-table do dataset

RowObject

Handle

 

 

 

X

Handle da temp-table do RowObject

hBoHandle

Handle

 

X

 

 

Handle da BO

RowErrors

Tt

 

 

 

X

Tabela RowErrors

 

Método: afterSelectedRecord

Descrição: Tem por objetivo ser executada após cada registro ter sido lido para que o usuário possa realizar customizações no registro (gerar informação de um campo virtual baseado nos valores do registro, validar a informação de uma coluna da tabela, etc).

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tableName

Char

 

X

 

 

Nome da tabela em questão

ttDataset

Handle

 

 

 

X

Handle da temp-table do dataset

 

Método: beforePersistRecord

Descrição: Tem por objetivo ser executada antes de realizar qualquer tipo de persistência (CREATE, UPDATE e DELETE) para que possa ser realizado a conversão dos valores virtuais para colunas físicas.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pType

Char

 

X

 

 

“CREATE”, “UPDATE” ou “DELETE”

ttDataset

Handle

 

 

 

X

Handle Handle da temp-table do dataset

RowObject

Handle

 

 

 

X

Handle Handle da temp-table do RowObject

hBoHandle

Handle

 

X

 

 

Handle da BO

 

Método: prepareQuery

Descrição: Tem por objetivo disponibilizar um meio de customizar a query que será executada para realizar a busca de dados.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

queryHandler

Handle

 

 

 

X

Handle da Query

 

Functions e Procedures Auxiliares

 

Método: prepareDatasetFields

Descrição: Esta PROCEDURE realiza o mapeamento de todos os campos que vieram no Dataset para que possa facilitar a forma de trabalhar com estas handles. Deve ser utilizada junto com a FUNCTION getDatasetFieldHandle.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

ttDataset

Handle

 

X

 

 

Handle da temp-table do dataset

 

Método: prepareRowObjectFields

Descrição: Esta PROCEDURE realiza o mapeamento de todos os campos que vieram do RowObject para que possa facilitar a forma de trabalhar com estas handles. Deve ser utilizada junto com a FUNCTION getRowObjFieldHandle.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

RowObject

Handle

 

 

 

X

Handle da temp-table do RowObject

 

Método: getDatasetFieldHandle

Descrição: Esta FUNCTION tem por objetivo retornar a handle de um determinado campo do dataset. Sua utilização está vinculada ao uso correto da procedure prepareDatasetFields.

Requisitos: Nenhum

Parâmetros: Recebe o tipo de validação (Create, Delete, Update)

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pName

Char

 

X

 

 

Nome do campo que deseja buscar

retorno

Handle

 

 

X

 

Handle do campo desejado

 

Método: getRowObjFieldHandle

Descrição: Esta FUNCTION tem por objetivo retornar a handle de um determinado campo da RowObject. Sua utilização está vinculada ao uso correto da procedure prepareRowObjectFields.

Requisitos: Nenhum 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pName

Char

 

X

 

 

Nome do campo que deseja buscar

retorno     

Handle

 

 

X

 

Handle do campo desejado

 

Pontos de UPC

 

Método: before-afterPersistRecord

Descrição: É executada ANTES da procedure “afterPersistRecord”.

 

Método: after-afterPersistRecord

Descrição: É executada APÓS da procedure “afterPersistRecord”.

 

Método: before-beforePersistRecord

Descrição: É executada ANTES da procedure “beforePersistRecord”.

 

Método: after-beforePersistRecord

Descrição: É executada APÓS da procedure “beforePersistRecord”.

 

Métodos de Negócio

Métodos específicos.

 

Método: setDatasetHandle.

Descrição: Seta o valor da handle.

Requisitos: Nenhum. 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

hProg

Hand

 

X

 

 

Parâmetro

 

Método: prepareTTAUX.

Descrição: Método auxilar.

Requisitos: Nenhum. 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

queryHandler

Handle

 

 

 

X