Objetivo

Listar e detalhar as funções do internalId.

register

Cadastra um InternalId que será utilizado pelos Adapters. Será cadastrado por ambos os aplicativos, porém, cada um com seus respectivos nomes de tabelas e valores que compõem o campo de chave primária.

Parâmetros:

Parâmetro

Tipo

Descrição

internalId

String

Código que identificará o InternalId. Utiliza-se o nome da mensagem para esse campo.

internalTable

String

Nome da tabela interna que possui os campos que serão utilizados para fazer a conversão de valores da InternalId.

internalColumn

String

Colunas da tabela utilizada para fazer a conversão de valores da InternalId. Todas as colunas serão registradas nesse campo separadas pelo caractere “|”.

Exemplo: “cod_empresa|nota_fiscal|serie_nota_ fiscal”.

Retorno:

Valor	Descrição
TRUE	Cadastrou corretamente o registro.
FALSE	Houve problemas durante o cadastro.

Exemplo de utilização em Progress:

IF oMapper:register("CustomerVendorInternalId","clientes","cod_empresa|cod_cliente") = TRUE THEN DO:    
	MESSAGE "Cadastro efetuado com sucesso" VIEW-AS ALERT-BOX.
END.
ELSE DO:
    MESSAGE "Problemas durante o cadastro" VIEW-AS ALERT-BOX.
END.

Exemplo de utilização em Java:

if(!internalIdMapperImpl.register("CustomerVendorInternalId","clientes", "cod_empresa|cod_cliente")) {        
	System.out.println("Problemas durante o cadastro");
} else {
    System.out.println("Cadastro efetuado com sucesso;");
}

existMapping (Progress) ou exists (Java)

Verifica se o internalid está registrado.

Parâmetros:

Parâmetro	Tipo	Descrição
internalId	String	Código do internalId a ser consultado
internalTable	String	Nome da tabela que será pesquisada juntamente com o InternalId.

Retorno:

Valor	Descrição
TRUE	Existe internalId consultado
FALSE	Não existe o internalId consultado

Exemplo de utilização em Progress:

IF oMapper:existMapping("CustomerVendorInternalId", "clientes") = TRUE THEN DO:    
	MESSAGE "Encontrou o registro" VIEW-AS ALERT-BOX.
END.
ELSE DO:
    MESSAGE "Não encontrou o registro" VIEW-AS ALERT-BOX.
END.

Exemplo de utilização em Java:

if(internalIdMapperImpl.exists("CustomerVendorInternalId", "clientes")) {        
	System.out.println("Encontrou o registro");
} else {
        System.out.println("Não encontrou o registro");
}

setValue

Função responsável por adicionar os valores relacionados ao InternalId do aplicativo interno e do aplicativo externo.

Utilizada pelo aplicativo destino da mensagem, ou seja, quando receber uma mensagem de Evento, o aplicativo verificará a necessidade da utilização do InternalId e, caso necessário, cadastrará um registro utilizando essa função.

Esta verificará se o argumento dos campos internos possui a mesma quantidade de campos do registro do InternalId (feito pela função register), garantindo a integridade dos campos do InternalId.

Parâmetros:

Parâmetro	Tipo	Descrição
internalId	String	Código do InternalId dos valores a ser incluído.
internalValue	String	Valores das colunas da tabela utilizadas mais o nome da tabela. Todas as colunas serão registradas nesse campo separadas pelo caractere “\|”. No final os valores das colunas serão separados da tabela pelo caractere “@”. Exemplo: “01\|234@pedidos”.
externalApplication	String	Código do aplicativo externo para identificar de quem é o valor dos campos externos. O código do aplicativo externo vem da mensagem de origem (BussinessMessage ou ReturnMessage) e deve ser extraído pela função do Adapter.
externalValue	String	Código dos valores do InternalId utilizado pelo aplicativo externo.