GlideCurrencyConverter : inclus dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • L’API GlideCurrencyConverter fournit des méthodes pour convertir une valeur de devise en une autre, telles que la conversion de dollars américains en euros européens.

    Vous pouvez instancier l’objet GlideCurrencyConverter et définir les devises source et de destination pendant l’instanciation à l’aide de GlideCurrencyConverter(from, to). Vous pouvez également instancier l’objet sans ces valeurs et les définir ultérieurement à l’aide des méthodes setFromCurrency() et setToCurrency(). Ces valeurs et le montant à convertir doivent être définis avant d’appeler la méthode convert() pour effectuer la conversion de devise. Pour définir le montant à convertir, utilisez la méthode setAmount().

    L’API GlideCurrencyConverter() fournit également des méthodes facultatives qui vous permettent de :
    • Définissez la date et l’heure auxquelles effectuer la conversion, setDateTime(). Si vous définissez la date et l’heure, le taux utilisé dans le calcul de conversion est celui de la date et de l’heure spécifiées, au lieu de la date et de l’heure actuelles par défaut.
    • Définissez la table de taux à utiliser dans la conversion, setRateTable(). Par défaut, la conversion utilise la table fx_system_rate. Toutefois, vous pouvez définir des tables de taux personnalisées pour votre instance. Pour plus d’informations sur la création de tableaux de taux, consultez l’article Ajouter des taux de conversion à l’aide d’un tableau de taux personnalisé.

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

    GlideCurrencyConverter - GlideCurrencyConverter()

    Instancie un objet GlideCurrencyConverter .

    Tableau 1. Paramètres
    Nom Type Description
    Aucun

    Cet exemple montre comment appeler la méthode.

    var conv = new sn_currency.GlideCurrencyConverter();

    GlideCurrencyConverter : GlideCurrencyConverter(chaîne de, chaîne vers)

    Instancie un objet GlideCurrencyConverter et définit les codes de pays source et de destination à utiliser dans la conversion de devise.

    Tableau 2. Paramètres
    Nom Type Description
    de Chaîne Code ISO 3166 à trois lettres de la devise d’origine.
    à Chaîne Code ISO 3166 à trois lettres de la devise convertie.

    Cet exemple montre comment appeler la méthode.

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

    GlideCurrencyConverter - convert()

    Exécute le convertisseur de devise.

    Appelez cette méthode après avoir appelé d’autres méthodes GlideCurrencyConverter qui construisent la conversion de devise, telles que setAmount(),setRateTable() et setDate().

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    Objet Si la conversion réussit, renvoie l’objet CurrencyExchangeValue. En cas d’échec, renvoie « null ».
    CurrencyExchangeValue {
Rate: Number,
OriginalAmount: Number,
Amount: Number,
fromCurrency: String,
toCurrency: String,
rateSysId: String
}

    Rate:Nombre. Taux de change utilisé dans la conversion.

    OriginalAmount:Nombre. Montant en devise source.

    Amount:Nombre. Montant converti (OriginalAmount * Rate).

    fromCurrency:Corde. Code ISO 3166 à trois lettres de la devise d’origine.

    toCurrency:Corde. Code ISO 3166 à trois lettres de la devise convertie.

    rateSysId:Corde. Sys_id de l’enregistrement de la table de taux utilisé pour calculer la conversion.

    Cet exemple montre comment appeler la méthode.

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

    Sortie :

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

    GlideCurrencyConverter : setAmount(montant de la chaîne)

    Définit le montant de devise à convertir.

    Tableau 5. Paramètres
    Nom Type Description
    calculer le montant de Chaîne Montant de devise à convertir. Cette valeur doit être non formatée, à l’exception d’une virgule décimale pour indiquer la devise fractionnaire. Par exemple, 1234,56 est valide, 1 234,56 est invalide.
    Tableau 6. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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

    GlideCurrencyConverter : setDateTime(date de l’objet)

    Définit la date et l’heure de conversion de devise.

    Cette date et cette heure déterminent le taux de conversion utilisé pour convertir la devise. Si cette méthode n’est pas appelée avant la méthode GlideCurrencyConverter.convert(), la conversion est effectuée en utilisant le taux de la date/heure actuelle.

    Tableau 7. Paramètres
    Nom Type Description
    date GlideDateTime Date/heure à laquelle calculer la conversion de devise. Cette valeur détermine le taux utilisé dans la conversion.
    Tableau 8. Renvoie
    Type Description
    nul

    L’exemple suivant montre comment appeler cette méthode.

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

    Sortie :

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

    GlideCurrencyConverter : setFromCurrency(Chaîne de)

    Définit le code de pays de la devise source.

    Tableau 9. Paramètres
    Nom Type Description
    de Chaîne Code ISO 3166 à trois lettres de la devise d’origine.
    Tableau 10. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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

    GlideCurrencyConverter : setRateTable(String rateTable)

    Définit la table de taux à utiliser dans la conversion de devise.

    Si cette méthode n’est pas appelée avant que la méthode GlideCurrencyConverter.convert() ne soit appelée, la conversion est effectuée à l’aide de la table fx_system_rate. Toutes les tables d’évaluation personnalisées doivent étendre la table fx_conversion_rate. Pour plus d’informations sur la création de tableaux de taux, consultez l’article Ajouter des taux de conversion à l’aide d’un tableau de taux personnalisé.

    Tableau 11. Paramètres
    Nom Type Description
    Table d’évaluation Chaîne Nom de la table de taux à utiliser dans la conversion de devise.
    Tableau 12. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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

    GlideCurrencyConverter : setToCurrency(String vers)

    Définit le code de pays de la devise de destination.

    Tableau 13. Paramètres
    Nom Type Description
    à Chaîne Code ISO 3166 à trois lettres de la devise d’origine.
    Tableau 14. Renvoie
    Type Description
    nul

    Cet exemple montre comment appeler la méthode.

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