Objetivo

Listar e detalhar as funções do internalId.

Objetivo

...

Listar e detalhar as funções utilizadas nos adapters para manipulação do InternalId. Para mais informações sobre o conceito de InternalId, consulte a documentação correspondente aqui.

register

...

Cadastra a estrutura de 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:

...

Retorno:

Exemplo de utilização em Progress:

IF oMapper:register("CustomerVendorInternalIdCustomerVendor","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("CustomerVendorInternalIdCustomerVendor","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á registradoa estrutura do InternalId está cadastrada.

Parâmetros:

...

Retorno:

...

Exemplo de utilização em Progress:

IF oMapper:existMapping("CustomerVendorInternalIdCustomerVendor", "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("CustomerVendorInternalIdCustomerVendor", "clientes")) {        
	System.out.println("Encontrou o registro");
} else {
        System.out.println("Não encontrou o registro");
}

...

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:

Retorno:

...

Exemplo de utilização em Progress:

IF oMapper:setValue("CustomerVendorInternalId"CustomerVendor", "clientes", "01|20@clientes20", "DATASUL_EAI","02|30|40|12345678") = 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.setValue("CustomerVendor", "CustomerVendorInternalIdclientes", "01|20@clientes20", "DATASUL_EAI","02|30|40|12345678")) {        
	System.out.println("Problemas durante o cadastro");
} else {
    System.out.println("Cadastro efetuado com sucesso");
}

...

Função responsável por resgatar o valor interno relacionado ao InternalId do aplicativo externo. Passa-se o código do InternalId e o nome do aplicativo externo para fazer o rastreamento do relacionamento da chave dos valores externos.

Parâmetros:

...

Retorno:

...

Exemplo de utilização em Progress:

DEFINE VARIABLE valor AS CHARACTER NO-UNDO. 
 
valor = oMapper:getValue("CustomerVendor", "CustomerVendorInternalIdclientes", "DATASUL_EAI","02|30|40|123456789").
MESSAGE "Valor retornado " + valor + " = 01|20@clientes20" VIEW-AS ALERT-BOX.

...

Exemplo de utilização em Java:

String valor = internalIdMapperImpl.getValue("CustomerVendor", "CustomerVendorInternalIdclientes", "DATASUL_EAI","02|30|40|123456789");
System.out.println("Valor retornado " + valor + " = 01|20@clientes20");

internalIdGetValue

...

Função responsável por extrair o valor de uma coluna de um campo interno do InternalId utilizando o nome da coluna registrada.

Passa-se o código do InternalId e o aplicativo externo para fazer o rastreamento do relacionamento da chave dos valores externos.

Parâmetros:

...

Retorno:

• internalValueColumn: String
  • Valor da coluna selecionada no campo internalValue;
  • Valor da coluna extraída do campo “InternalValue” correspondente à posição da coluna da InternalId referenciada pelo “campo”;
  • NULL: quando não encontrar o valor correspondente aos parâmetros passados.

...

Exemplo de utilização em Progress:

DEFINE VARIABLE valor AS CHARACTER NO-UNDO.
  
valor = oMapper:internalIdGetValue("CustomerVendorInternalId","01|20@clientes",?,"cod_empresa").
MESSAGE "Valor retornado" + valor + "= '01'" VIEW-AS ALERT-BOX.
  
valor = oMapper:internalIdGetValue("CustomerVendorInternalId","01|20","clientes","cod_cliente").
MESSAGE "Valor retornado" + valor + "= '20'" VIEW-AS ALERT-BOX.

...

Exemplo de utilização em Java:

String valor = internalIdMapperImpl.internalIdGetValue("CustomerVendorInternalId", "01|20@clientes", null, "cod_empresa");
System.out.println("Valor retornado" + valor + "= '01'");
                
valor  = internalIdMapperImpl.internalIdGetValue("CustomerVendorInternalId", "01|20", "clientes", "cod_cliente");
System.out.println("Valor retornado" + valor + "= '20'");

...

Função responsável por excluir o(s) registro(s) que contenha(m) os valores do InternalId com os parâmetros selecionados.

Parâmetros:

Retorno:

...

Exemplo de utilização em Progress:

IF oMapper:deleteValue("_CustomerVendorInternalId_","01|20@clientes") = TRUE THEN DO:    
	MESSAGE "Exclusão do internalid com o valor: '01|20@clientes' para todos os Aplicativos externos." VIEW-AS ALERT-BOX.
END.
ELSE DO:
    MESSAGE "Problemas com a exclusão." VIEW-AS ALERT-BOX.
END.
  
IF oMapper:deleteValue("_CustomerVendorInternalId_","01|20@clientes","DATASUL_EAI") = TRUE THEN DO:
    MESSAGE "Exclusão do internalid com o valor: '01|20@clientes' para a aplicativo externo: 'LogixApp'." VIEW-AS ALERT-BOX.
END.
ELSE DO:
    MESSAGE "Problemas com a exclusão." VIEW-AS ALERT-BOX.
END.

Exemplo de utilização em Java:

if(internalIdMapperImpl.deleteValue("CustomerVendorInternalId", "01|20@clientes")) {
	System.out.println("Exclusão do internalid com o valor: '01|20@clientes' para todos os Aplicativos externos.");
} else {
    System.out.println("Problemas com a exclusão.");
}
                
if(internalIdMapperImpl.deleteValue("CustomerVendorInternalId", "01|20@clientes","LogixApp")) {
    System.out.println("Exclusão do internalid com o valor: '01|20@clientes' para a aplicativo externo: 'LogixApp'.");
} else {
    System.out.println("Problemas com a exclusão.");
}

...

Função responsável por excluir o registro do InternalId com os parâmetros selecionados.

Parâmetros:

...

Retorno:

Exemplo de utilização em Progress:

IF oMapper:deleteMapping("CustomerVendorInternalId","fornecedores") = TRUE THEN DO:    
	MESSAGE "Exclusão do internalid efetuada com sucesso" VIEW-AS ALERT-BOX.
END.
ELSE DO:
    MESSAGE "Problemas com a exclusão." VIEW-AS ALERT-BOX.
END.

Exemplo de utilização em Java:

if(internalIdMapperImpl.delete("CustomerVendorInternalId","fornecedores")) {        
	System.out.println("Exclusão do internalid efetuada com sucesso");
} else {
    System.out.println("Problemas com a exclusão.");
}