GlideCurrencyConverter : inclus dans le champ d’application

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 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 lors de 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(). En définissant la date et l’heure, le taux utilisé dans le calcul de la conversion est celui pour la date et l’heure spécifiées, au lieu de la valeur par défaut de la date et de l’heure actuelles.
    • Définissez la table de taux à utiliser dans la conversion, setRateTable(). Par défaut, la conversion utilise la table fx_system_rate, mais vous pouvez définir des tables de taux personnalisées pour votre instance. Pour plus d’informations sur la création de tables de taux, consultez Ajouter des taux de conversion à l’aide d’une table de taux personnalisée.

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

    GlideCurrencyConverter inclus dans le champ d’application - 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 1. Paramètres
    Nom Type Description
    Aucun
    Tableau 2. 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 de la devise source.

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

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

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

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

    Exemple

    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 inclus dans le périmètre : GlideCurrencyConverter()

    Instancie un objet GlideCurrencyConverter .

    Tableau 3. Paramètres
    Nom Type Description
    Néant

    Exemple

    var conv = new sn_currency.GlideCurrencyConverter();

    GlideCurrencyConverter inclus dans le périmètre : 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 4. Paramètres
    Nom Type Description
    de Chaîne Code pays ISO 3166 à trois lettres de la devise d’origine.
    à Chaîne Code pays ISO 3166 à trois lettres de la devise convertie.

    Exemple

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

    GlideCurrencyConverter inclus dans le périmètre : setAmount(String amount)

    Définit le montant de devise à convertir.

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

    Exemple

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

    GlideCurrencyConverter inclus dans le champ d’application : 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 à l’aide du taux de la date/heure actuelle.

    Tableau 7. Paramètres
    Nom Type Description
    date GlideDateTime Date/heure pour 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 inclus dans le périmètre : setFromCurrency(String from)

    Définit le code pays de la devise source.

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

    Exemple

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

    GlideCurrencyConverter inclus dans le périmètre : setRateTable(String rateTable)

    Définit la table de taux à utiliser pour 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 de taux personnalisées doivent étendre la table de fx_conversion_rate. Pour plus d’informations sur la création de tables de taux, consultez Ajouter des taux de conversion à l’aide d’une table de taux personnalisée.

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

    Exemple

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

    GlideCurrencyConverter inclus dans le champ d’application : setToCurrency(String to)

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

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

    Exemple

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