GlideCurrencyConfig - com escopo

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

    • A API GlideCurrencyConfig fornece métodos para recuperar várias informações de configuração para campos de moeda de FX.

    Você pode adquirir informações para um campo de moeda de FX específico chamando o construtor GlideCurrencyConfig(Object ed), que associa um campo de moeda de FX específico ao objeto instanciado. Ao chamar os vários métodos GlideCurrencyConfig(), se houver um registro na tabela Configuração de moeda de FX [fx_configuration] para o campo Moeda de FX, o valor solicitado será passado de volta. Se um registro ou campo não estiver disponível, o valor padrão será passado de volta. Você também pode adquirir os valores de configuração de moeda de FX padrão chamando o construtor GlideCurrencyConfig().

    Para obter informações adicionais sobre a configuração da moeda de FX, consulte Configuração e operação de campos de moeda de FX.

    Esta classe é executada no namespace sn_currency.

    GlideCurrencyConfig - GlideCurrencyConfig()

    Instancia um objeto GlideCurrencyConfig que permite a recuperação de informações de configuração de moeda de FX padrão global.

    Ao chamar os métodos disponíveis neste tipo de objeto GlideCurrencyConfig, os valores de retorno são os padrões globais de moeda de FX das propriedades do sistema. Se um padrão global não estiver definido nas propriedades do sistema, um padrão codificado será retornado (também pode ser um valor vazio se não estiver configurado).

    Este objeto não fornece informações de configuração para um campo de moeda de FX específico. Para recuperar informações específicas do campo Moeda de FX, use o construtor GlideCurrencyConfig(Object ed).

    Para obter mais informações, consulte Como definir configurações globais de moeda de FX.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum 
    var cur_config = new sn_currency.GlideCurrencyConfig();

    GlideCurrencyConfig - GlideCurrencyConfig (objeto ed)

    Instancia um objeto GlideCurrencyConfig que permite a recuperação das informações de configuração para um campo de moeda de FX específico.

    Ao chamar os métodos disponíveis neste tipo de objeto GlideCurrencyConfig, os valores de retorno são do registro FX Currency Configuration [fx_configuration] associado ao campo FX Currency, se existir um registro. Se um registro não existir, os valores padrão serão retornados.

    Para obter mais informações, consulte Como definir configurações globais de moeda de FX.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    ed GlideElementDescriptor Objeto GlideElementDescriptor do campo Moeda de FX a ser associado ao objeto GlideCurrencyConfig. 
    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);

    GlideCurrencyConfig – getAggregationSource()

    Retorna o valor de origem de agregação para um campo de Moeda de FX.

    Se chamado em um campo de Moeda de FX existente que tem um registro de Configuração de Moeda de FX [fx_configuration] correspondente, retorna o valor do campo Origem de Agregação (aggregation_source). Caso contrário, se for um novo registro, retornará um valor padrão.

    Para obter mais informações sobre a origem de agregação, consulte Especificar o campo da tabela e seus parâmetros de exibição de moeda.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres Origem de valores para agregações. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o campo aggregation_source do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): se definido, retorna o valor no campo glide.currency2.aggregation_source nas propriedades do sistema. Caso contrário, retorna um padrão codificado de referência.
    Valores possíveis:
    • padrão
    • as_entered
    • referência

    Este exemplo de código retorna a origem de agregação padrão.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_agg_source = cur_config.getAggregationSource();

    Este exemplo de código retorna a origem de agregação para um campo específico de Moeda de FX.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_agg_source = cur_config.getAggregationSource();

    GlideCurrencyConfig – getConversionDateSource()

    Retorna o campo usado como origem da data e hora da conversão de moeda.

    Se chamado em um campo de Moeda de FX existente que tem um registro de Configuração de Moeda de FX [fx_configuration] correspondente, retorna o valor do campo Origem da data de conversão (conversion_date_source). Caso contrário, se for um novo registro, retornará "nulo".

    Para obter mais informações sobre o campo Origem da data de conversão, consulte Identificar a tabela de taxas e a origem da data para conversões de moeda.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Cadeia de caracteres Campo no registro usado como fonte de data de conversão. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o campo conversation_date_source do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): retorna nulo.

    Este exemplo de código retorna a origem da data de conversão para um campo específico de Moeda de FX.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_conv_date_src = cur_config.getConversionDateSource();

    GlideCurrencyConfig – getDisplayDigits()

    Retorna o número de dígitos a serem exibidos para um campo de Moeda de FX.

    Se chamado em um campo de Moeda de FX existente que tem um registro de Configuração de Moeda de FX [fx_configuration] correspondente, retorna o valor do campo Exibir dígitos (display_digits). Caso contrário, se for um novo registro, retornará um valor padrão.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Número Número de dígitos a serem exibidos para o campo Moeda de FX. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se houver um registro fx_configuration, retornará o valor do campo display_digits no registro de configuração de moeda de FX [fx_configuration] que está associado ao campo de moeda de FX especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): se definido, retorna o valor da propriedade glide.currency2.display_digits nas propriedades do sistema. Caso contrário, retorna -1.

    Este exemplo de código retorna o número padrão de dígitos de exibição.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_display_digits = cur_config.getDisplayDigits();

    Este exemplo de código retorna os dígitos de exibição de um campo específico de Moeda de FX.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_display_digits = cur_config.getDisplayDigits();

    GlideCurrencyConfig – getDisplayValue()

    Retorna o código da moeda usado para converter o valor da Moeda de FX quando ele aparece em listas e relatórios.

    Se chamado em um campo de Moeda de FX existente que tem um registro de Configuração de Moeda de FX [fx_configuration] correspondente, retorna o valor do campo Moeda do Valor de Exibição (display_value). Caso contrário, se for um novo registro, retornará um valor padrão.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres Código da moeda a ser usado para exibir o campo Moeda de FX. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o campo display_value, que contém o código da moeda, do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): se definido, retorna o valor da propriedade glide.currency2.display_value nas propriedades do sistema. Caso contrário, retorna as_entered.
    Valores possíveis:
    • padrão: padrão global. Este é o valor na propriedade glide.currency2.display_digits.
    • as_entered: valor da moeda conforme inserido pelo usuário.
    • in_session_currency: valor da moeda convertido para a moeda da sessão. A moeda da sessão é baseada na localidade do usuário.
    • in_reference_currency: valor de referência se calculado e armazenado. Caso contrário, o valor da moeda será convertido para a moeda de referência.

    Este exemplo de código retorna o código de moeda padrão.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_display_value = cur_config.getDisplayValue();

    Este exemplo de código retorna o código de moeda de exibição para um campo específico de Moeda de FX.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_display_value = cur_config.getDisplayValue();

    GlideCurrencyConfig – getRateFilterRateTableField()

    Retorna o campo da tabela de taxas usado como filtro da tabela de taxas para um campo de Moeda de FX.

    Se chamado em um campo de moeda de FX existente que tem um registro de configuração de moeda de FX correspondente [fx_configuration], retorna o valor do campo da tabela de taxas (rate_filter_rate_table_field). Caso contrário, se for um novo registro, retornará um valor padrão.

    Para obter mais informações sobre filtros de tabela de taxas, consulte Selecionar os campos da tabela de taxa e meta usados para filtragem.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Cadeia de caracteres Campo na tabela de taxas usado para filtrar os registros da tabela de taxas. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o rate_filter_rate_table_field do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): retorna nulo.

    Este exemplo de código retorna o campo da tabela de taxas usado para filtrar registros da tabela de taxas para um campo de moeda de FX específico.

    var grCurr = new GlideRecord('my_FXurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_reference_currency = cur_config.getRateFilterRateTableField();

    GlideCurrencyConfig – getRateFilterTargetTableField()

    Retorna o campo da tabela de destino usado para filtrar os registros da tabela de taxas para um campo de moeda de FX.

    Se chamado em um campo de moeda de FX existente que tem um registro de configuração de moeda de FX [fx_configuration] correspondente, retorna o valor do campo da tabela de destino (rate_filter_target_table_field). Caso contrário, se for um novo registro, retornará um valor padrão.

    Para obter mais informações sobre filtros de tabela de taxas, consulte Selecionar os campos da tabela de taxa e meta usados para filtragem.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Cadeia de caracteres Campo na tabela de destino usado/a ser usado para filtrar a tabela de taxas. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se houver um registro fx_configuration, retornará o rate_filter_target_table_field do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): retorna nulo.

    Este exemplo de código retorna o filtro de taxa padrão, o campo da tabela de destino.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_rate_filter = cur_config.getRateFilterTargetTableField();

    Este exemplo de código retorna o filtro de taxa e o campo da tabela de destino para um campo de moeda de FX específico.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_rate_filter = cur_config.getRateFilterTargetTableField();

    GlideCurrencyConfig – getRateTable()

    Retorna a tabela de taxas usada para converter a moeda de um campo de moeda de FX.

    Se chamado em um campo de moeda de FX existente que tem um registro de configuração de moeda de FX correspondente [fx_configuration], retorna o valor do campo da tabela de taxas (rate_filter_rate_table_field). Caso contrário, se for um novo registro, retornará um valor padrão.

    Para obter mais informações sobre tabelas de taxas da moeda FX, consulte Identificar a tabela de taxas e a fonte de data para conversões de moeda.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 16. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome da tabela de taxas usada para executar a conversão de moeda. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o campo rate_table_field do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): se definido, retorna o valor da propriedade glide.currency2.system_rate_table das propriedades do sistema. Caso contrário, retorna fx_system_rate.

    Retorna a tabela de taxas padrão.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_rate_table = cur_config.getRateTable();

    Retorna a tabela de taxas usada para um campo específico de Moeda de FX.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_rate_table = cur_config.getRateTable();

    GlideCurrencyConfig – getReferenceCurrency()

    Retorna a moeda de referência para um campo de Moeda de FX.

    Se chamado em um campo de Moeda de FX existente que tem um registro de Configuração de Moeda de FX [fx_configuration] correspondente, retorna o valor do campo Moeda de Referência (reference_currency). Caso contrário, se for um novo registro, retornará um valor padrão.

    Para obter mais informações sobre a moeda de referência, consulte Definir a moeda de referência.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 18. Retorna
    Tipo Descrição
    Cadeia de caracteres Moeda de referência como um código de moeda ISO. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o campo reference_currency do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): se definido, retorna o valor da propriedade do sistema glide.currency2.default_reference_currency. Caso contrário, o método aplica as seguintes regras, na ordem especificada, para determinar o código da moeda de referência:
      • Se a propriedade do sistema glide.system.reference_currency estiver definida como verdadeira, usará o valor na propriedade do sistema glide.system.reference_currency.code.
      • O valor na propriedade do sistema glide.system.locale (o que implica uma moeda).
      • Localidade padrão da Java Virtual Machine na qual a instância está sendo executada.

    Este exemplo de código retorna a moeda de referência padrão.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_reference_currency = cur_config.getReferenceCurrency();

    Este exemplo de código retorna a moeda de referência para um campo de moeda de FX específico.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_reference_currency = cur_config.getReferenceCurrency();

    GlideCurrencyConfig – getReferenceCurrencySource()

    Retorna a origem da moeda de referência para um campo de Moeda de FX.

    Se chamado em um campo de Moeda de FX existente que tem um registro de Configuração de Moeda de FX [fx_configuration] correspondente, retorna o valor (caminho de referência com pontos) do campo Origem da Moeda de Referência (reference_currency_source). Caso contrário, se for um novo registro, retornará um valor padrão.

    Para obter mais informações sobre a origem da moeda de referência, consulte Definir a moeda de referência.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 20. Retorna
    Tipo Descrição
    Cadeia de caracteres Caminho de referência com pontos do campo usado/a ser usado como moeda de referência. O valor retornado depende do construtor usado para instanciar o objeto.
    • GlideCurrencyConfig(Object ed): se existir um registro fx_configuration, retornará o campo reference_currency_source do registro fx_configuration que está associado ao campo FX Currency especificado pelo GlideElementDescriptor passado no construtor. Se não houver registro fx_configuration, seguirá as regras GlideCurrencyConfig().
    • GlideCurrencyConfig(): retorna nulo.

    Este exemplo de código retorna a origem da moeda de referência padrão.

    var cur_config = new sn_currency.GlideCurrencyConfig();
var curr_reference_currency = cur_config.getReferenceCurrencySource();

    Este exemplo de código retorna a origem da moeda de referência para um campo de moeda de FX específico.

    var grCurr = new GlideRecord('my_FXCurrency_table');
var curr_field = grCurr.getElement('currency');
var ed = curr_field.getED();
var cur_config = new sn_currency.GlideCurrencyConfig(ed);
var curr_reference_currency = cur_config.getReferenceCurrencySource();