GlideCurrencyConverter - com escopo

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura

    • A API GlideCurrencyConverter fornece métodos para converter um valor de moeda em outro, como converter dólares norte-americanos em reais.

    Você pode instanciar o objeto GlideCurrencyConverter e definir as moedas de origem e destino durante a instanciação usando GlideCurrencyConverter(from, to). Você também pode instanciar o objeto sem esses valores e defini-los posteriormente usando os métodos setFromCurrency() e setToCurrency(). Esses valores e o valor a ser convertido devem ser definidos antes de chamar o método convert() para executar a conversão de moeda. Para definir o valor a ser convertido, use o método setAmount().

    A API GlideCurrencyConverter() também fornece métodos opcionais que permitem:
    • Defina a data e a hora para a qual a conversão será executada, setDateTime(). Ao definir a data e a hora, a taxa usada no cálculo de conversão é a da data e hora especificadas, em vez do padrão da data e hora atuais.
    • Defina a tabela de taxas a ser usada na conversão, setRateTable(). Por padrão, a conversão usa a tabela fx_system_rate. No entanto, você pode definir tabelas de taxas personalizadas para sua instância. Para obter informações adicionais sobre como criar tabelas de taxas, consulte Adição de taxas de conversão usando uma tabela de taxas personalizada.

    Esta classe é executada no namespace sn_currency.

    GlideCurrencyConverter - GlideCurrencyConverter()

    Instancia um objeto GlideCurrencyConverter.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter();

    GlideCurrencyConverter - GlideCurrencyConverter (cadeia de caracteres de, cadeia de caracteres para)

    Instancia um objeto GlideCurrencyConverter e define os códigos de país de origem e destino a serem usados na conversão de moeda.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    de Cadeia de caracteres Código de país ISO 3166 de três letras da moeda de origem.
    a Cadeia de caracteres Código de país ISO 3166 de três letras da moeda convertida.

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');

    GlideCurrencyConverter - convert()

    Executa o conversor de moeda.

    Chame este método depois de chamar outros métodos GlideCurrencyConverter que constroem a conversão de moeda, como setAmount(), setRateTable()e setDate().

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Objeto Se a conversão for bem-sucedida, retornará o objeto CurrencyExchangeValue. Se malsucedido, retorna "nulo".
    CurrencyExchangeValue {
Rate: Number,
OriginalAmount: Number,
Amount: Number,
fromCurrency: String,
toCurrency: String,
rateSysId: String
}

    Rate: Número. Taxa de câmbio usada na conversão.

    OriginalAmount: Número. Valor na moeda de origem.

    Amount: Número. Valor convertido (OriginalAmount * Rate).

    fromCurrency: cadeia de caracteres. Código de país ISO 3166 de três letras da moeda de origem.

    toCurrency: cadeia de caracteres. Código de país ISO 3166 de três letras da moeda convertida.

    rateSysId: cadeia de caracteres. Sys_id do registro da tabela de taxas usado para calcular a conversão.

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setAmount(100);
gs.info(conv.convert());

    Saída:

    CurrencyExchangeValue{Rate = 1.0777, OriginalAmount = 100, Amount = 107.7700, fromCurrency = 'EUR', toCurrency = 'USD', rateSysId = '2ed537fcb271937adb'}

    GlideCurrencyConverter - setAmount(cadeia de caracteres valor)

    Define o valor da moeda a ser convertido.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    valor Cadeia de caracteres Valor da moeda a ser convertido. Este valor deve estar sem formatação, exceto por uma vírgula decimal para denotar moeda fracionária. Por exemplo, 1234.56 é válido, 1.234.56 é inválido.
    Tabela 6. Retorna
    Tipo Descrição
    vazio

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setAmount(100);

    GlideCurrencyConverter - setDateTime(Data do objeto)

    Define a data e a hora da conversão da moeda.

    Esta data e hora determinam a taxa de conversão usada para converter a moeda. Se este método não for chamado antes do método GlideCurrencyConverter.convert(), a conversão será realizada usando a taxa para a data/hora atual.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    data GlideDateTime Data/hora para a qual a conversão de moeda será calculada. Este valor determina a taxa que é usada na conversão.
    Tabela 8. Retorna
    Tipo Descrição
    vazio

    O exemplo a seguir mostra como chamar este método.

    var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setAmount(100);
var gd = new GlideDateTime("2019-01-03 11:00:00");
conv.setDateTime(gd);
gs.info(conv.convert());

    Saída:

    CurrencyExchangeValue{fOriginalAmount=100, fOriginalCurrency='EUR', fRate=1.061, fAmount=106.1, fCurrency='USD', fRateSysId='4555525f5553445f3130303030313031'}

    GlideCurrencyConverter - setFromCurrency(cadeia de caracteres de)

    Define o código do país da moeda de origem.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    de Cadeia de caracteres Código de país ISO 3166 de três letras da moeda de origem.
    Tabela 10. Retorna
    Tipo Descrição
    vazio

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter().setFromCurrency('FRA');

    GlideCurrencyConverter - setRateTable(cadeia de caracteres rateTable)

    Define a tabela de taxas a ser usada na conversão de moeda.

    Se este método não for chamado antes que o método GlideCurrencyConverter.convert() seja chamado, a conversão será realizada usando a tabela fx_system_rate. Todas as tabelas de taxas personalizadas devem estender a tabela fx_conversion_rate. Para obter informações adicionais sobre como criar tabelas de taxas, consulte Adição de taxas de conversão usando uma tabela de taxas personalizada.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    rateTable Cadeia de caracteres Nome da tabela de taxas a ser usada na conversão de moeda.
    Tabela 12. Retorna
    Tipo Descrição
    vazio

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setRateTable(custom_rate_table);

    GlideCurrencyConverter - setToCurrency(cadeia de caracteres para)

    Define o código do país da moeda de destino.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    a Cadeia de caracteres Código de país ISO 3166 de três letras da moeda de origem.
    Tabela 14. Retorna
    Tipo Descrição
    vazio

    Este exemplo mostra como chamar o método.

    var conv = new sn_currency.GlideCurrencyConverter().setToCurrency('USA');