GlideCurrencyConfig : inclus dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 12 minutes de lecture
  • L’API GlideCurrencyConfig fournit des méthodes permettant de récupérer diverses informations de configuration pour les champs de devise FX.

    Vous pouvez obtenir des informations pour un champ Devise FX spécifique en appelant le constructeur GlideCurrencyConfig(Object ed), qui associe un champ Devise FX spécifique à l’objet instancié. Lors de l’appel des différentes méthodes GlideCurrencyConfig(), si un enregistrement existe dans la table Configuration de la devise FX [fx_configuration] pour le champ Devise FX, la valeur demandée est renvoyée. Si un enregistrement ou un champ n’est pas disponible, la valeur par défaut est renvoyée. Vous pouvez également acquérir les valeurs de configuration FX Currency par défaut en appelant le constructeur GlideCurrencyConfig().

    Pour plus d’informations sur la configuration de la devise FX, consultez Configuration et exploitation des champs de devises FX.

    Cette classe s’exécute dans l’espace de noms sn_currency .

    GlideCurrencyConfig : GlideCurrencyConfig()

    Instancie un objet GlideCurrencyConfig qui permet de récupérer les informations de configuration de la devise FX par défaut globales.

    Lors de l’appel des méthodes disponibles sur ce type d’objet GlideCurrencyConfig, les valeurs de retour sont les valeurs par défaut globales de la devise FX des propriétés système. Si une valeur par défaut globale n’est pas définie dans les propriétés système, une valeur par défaut codée en dur est renvoyée (elle peut également être une valeur vide si elle n’est pas configurée).

    Cet objet ne fournit pas d’informations de configuration pour un champ de devise FX spécifique. Pour récupérer des informations spécifiques sur le champ Devise FX, utilisez le constructeur GlideCurrencyConfig(Object ed).

    Pour plus d’informations, reportez-vous à la section Configuration des paramètres globaux de la devise FX.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun
    var cur_config = new sn_currency.GlideCurrencyConfig();

    GlideCurrencyConfig - GlideCurrencyConfig(objet ed)

    Instancie un objet GlideCurrencyConfig qui permet de récupérer les informations de configuration pour un champ de devise FX spécifique.

    Lors de l’appel des méthodes disponibles sur ce type d’objet GlideCurrencyConfig, les valeurs de retour proviennent de l’enregistrement de configuration de devise FX [fx_configuration] associé au champ Devise FX, s’il existe un enregistrement. Si aucun enregistrement n’existe, les valeurs par défaut sont renvoyées.

    Pour plus d’informations, reportez-vous à la section Configuration des paramètres globaux de la devise FX.

    Tableau 2. Paramètres
    Nom Type Description
    Ed GlideElementDescriptor Objet GlideElementDescriptor du champ Devise FX à associer à l’objet 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()

    Renvoie la valeur de la source d’agrégation pour un champ Devise FX.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement de configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Source d’agrégation (aggregation_source). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Pour plus d’informations sur la source d’agrégation, consultez Spécifier le champ de table et ses paramètres d’affichage de devise.

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    Chaîne Source des valeurs pour les agrégations. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le champ aggregation_source à partir de l’enregistrement fx_configuration associé au champ FX Currency spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : si activée, renvoie la valeur du champ glide.currency2.aggregation_source dans les propriétés système. Dans le cas contraire, renvoie une référence par défaut codée en dur.
    Valeurs possibles :
    • Par défaut
    • as_entered
    • référence

    Cet exemple de code renvoie la source d’agrégation par défaut.

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

    Cet exemple de code renvoie la source d’agrégation pour un champ Devise FX spécifique.

    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()

    Renvoie le champ utilisé comme source de la date et de l’heure de la conversion de devise.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement Configuration de devise FX [fx_configuration] correspondant, renvoie la valeur du champ Source de la date de conversion (conversion_date_source). Sinon, s’il s’agit d’un nouvel enregistrement, renvoie « null ».

    Pour plus d’informations sur le champ Source de la date de conversion, consultez Identifier la table de taux et la source de date pour les conversions de devises.

    Tableau 5. Paramètres
    Nom Type Description
    Aucun
    Tableau 6. Renvoie
    Type Description
    Chaîne Champ de l’enregistrement utilisé comme source de la date de conversion. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le champ conversion_date_source à partir de l’enregistrement fx_configuration associé au champ FX Currency spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : renvoie null.

    Cet exemple de code renvoie la source de date de conversion pour un champ Devise FX spécifique.

    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()

    Renvoie le nombre de chiffres à afficher pour un champ Devise FX.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement Configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Chiffres d’affichage (display_digits). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    Numéro Nombre de chiffres à afficher dans le champ Devise FX. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie la valeur du champ display_digits dans l’enregistrement Configuration de la devise FX [fx_configuration] associé au champ Devise FX spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : si activée, renvoie la valeur de la propriété glide.currency2.display_digits dans les propriétés système. Sinon, renvoie -1.

    Cet exemple de code renvoie le nombre de chiffres d’affichage par défaut.

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

    Cet exemple de code renvoie les chiffres d’affichage d’un champ Devise FX spécifique.

    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()

    Renvoie le code de devise utilisé pour convertir la valeur Devise FX lorsqu’elle apparaît dans des listes et des rapports.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement de configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Devise de la valeur d’affichage (display_value). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne Code de devise à utiliser pour afficher le champ Devise FX. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le champ display_value, qui contient le code de devise, à partir de l’enregistrement fx_configuration associé au champ Devise FX spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : si activée, renvoie la valeur de la propriété glide.currency2.display_value dans les propriétés système. Dans le cas contraire, renvoie as_entered.
    Valeurs possibles :
    • default : global par défaut. Il s’agit de la valeur de la propriété glide.currency2.display_digits.
    • as_entered : valeur de la devise saisie par l’utilisateur.
    • in_session_currency : valeur de devise convertie en devise de la session. La devise de la session est basée sur les paramètres régionaux de l’utilisateur.
    • in_reference_currency : valeur de référence si elle est calculée et stockée. Dans le cas contraire, la valeur de la devise est convertie en devise de référence.

    Cet exemple de code renvoie le code de devise par défaut.

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

    Cet exemple de code renvoie le code de devise d’affichage pour un champ de devise FX spécifique.

    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()

    Renvoie le champ de table de taux utilisé comme filtre de table de taux pour un champ de devise FX.

    S’il est appelé sur un champ Devise FX existant qui possède un enregistrement Configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Table de taux (rate_filter_rate_table_field). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Pour plus d’informations sur les filtres de table de taux, consultez Sélectionner les champs de table de taux et de table cible utilisés pour le filtrage.

    Tableau 11. Paramètres
    Nom Type Description
    Aucun
    Tableau 12. Renvoie
    Type Description
    Chaîne Champ de la table de taux utilisé pour filtrer les enregistrements de la table de taux. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie la rate_filter_rate_table_field de l’enregistrement fx_configuration associé au champ Devise FX spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : renvoie null.

    Cet exemple de code renvoie le champ de table de taux utilisé pour filtrer les enregistrements de table de taux pour un champ de devise FX spécifique.

    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()

    Renvoie le champ de table cible utilisé pour filtrer les enregistrements de table de taux pour un champ de devise FX.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement de configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Table cible (rate_filter_target_table_field). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Pour plus d’informations sur les filtres de table de taux, consultez Sélectionner les champs de table de taux et de table cible utilisés pour le filtrage.

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    Chaîne Champ de la table cible utilisé/à utiliser pour filtrer la table de taux. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le rate_filter_target_table_field de l’enregistrement fx_configuration associé au champ FX Currency spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : renvoie null.

    Cet exemple de code renvoie le filtre de taux par défaut, champ de table cible.

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

    Cet exemple de code renvoie le filtre de taux, le champ de table cible pour un champ de devise FX spécifique.

    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()

    Renvoie la table de taux utilisée pour convertir une devise en un champ de devise FX.

    S’il est appelé sur un champ Devise FX existant qui possède un enregistrement Configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Table de taux (rate_filter_rate_table_field). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Pour plus d’informations sur les tables de taux de change, voir Identifier la table des taux et la source de date pour les conversions de devises.

    Tableau 15. Paramètres
    Nom Type Description
    Aucun
    Tableau 16. Renvoie
    Type Description
    Chaîne Nom de la table de taux utilisée pour effectuer la conversion de devise. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le champ de rate_table_field à partir de l’enregistrement fx_configuration associé au champ FX Currency spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : si activée, renvoie la valeur de la propriété glide.currency2.system_rate_table à partir des propriétés système. Dans le cas contraire, renvoie fx_system_rate.

    Renvoie la table de taux par défaut.

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

    Renvoie la table de taux utilisée pour un champ de devise FX spécifique.

    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()

    Renvoie la devise de référence pour un champ Devise FX.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement Configuration de devise FX correspondant [fx_configuration], renvoie la valeur du champ Devise de référence (reference_currency). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Pour plus d’informations sur la devise de référence, reportez-vous à la rubrique Définir la devise de référence.

    Tableau 17. Paramètres
    Nom Type Description
    Aucun
    Tableau 18. Renvoie
    Type Description
    Chaîne Devise de référence sous forme de code de devise ISO. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le champ reference_currency de l’enregistrement fx_configuration associé au champ Devise FX spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : si activée, renvoie la valeur de la propriété système glide.currency2.default_reference_currency. Dans le cas contraire, la méthode applique les règles suivantes, dans l’ordre spécifié, pour déterminer le code de devise de référence :
      • Si la propriété système glide.system.reference_currency est définie sur true, utilise la valeur de la propriété système glide.system.reference_currency.code.
      • Valeur de la propriété système glide.system.locale (qui implique une devise).
      • Paramètres régionaux par défaut de l’ordinateur virtuel Java sur lequel l’instance est en cours d’exécution.

    Cet exemple de code renvoie la devise de référence par défaut.

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

    Cet exemple de code renvoie la devise de référence pour un champ Devise FX spécifique.

    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()

    Renvoie la source de devise de référence pour un champ Devise FX.

    S’il est appelé sur un champ Devise FX existant qui a un enregistrement Configuration de devise FX correspondant [fx_configuration], renvoie la valeur (chemin de remontée pas à pas) du champ Source de devise de référence (reference_currency_source). Dans le cas contraire, s’il s’agit d’un nouvel enregistrement, renvoie une valeur par défaut.

    Pour plus d’informations sur la source de la devise de référence, consultez Définir la devise de référence.

    Tableau 19. Paramètres
    Nom Type Description
    Aucun
    Tableau 20. Renvoie
    Type Description
    Chaîne Chemin de remontée pas à pas du champ utilisé/à utiliser comme devise de référence. La valeur renvoyée dépend du constructeur utilisé pour instancier l’objet.
    • GlideCurrencyConfig(Object ed) : si un enregistrement fx_configuration existe, renvoie le champ de reference_currency_source à partir de l’enregistrement de fx_configuration associé au champ FX Currency spécifié par le GlideElementDescriptor transmis dans le constructeur. S’il n’y a pas d’enregistrement fx_configuration, suivez les règles GlideCurrencyConfig().
    • GlideCurrencyConfig() : renvoie null.

    Cet exemple de code renvoie la source de devise de référence par défaut.

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

    Cet exemple de code renvoie la source de devise de référence pour un champ Devise FX spécifique.

    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();