GlideCurrencyFormatter : dans l’étendue

L’API GlideCurrencyFormatter fournit des méthodes pour formater les chaînes de devises FX.

Lors de l’instanciation de l’objet GlideCurrencyForformat, vous définissez le format des résultats de sortie pour cet objet. Une fois défini, le même format est utilisé chaque fois que vous appelez la méthode GlideCurrencyFormatter.format() de cet objet. Les méthodes GlideCurrencyFormatter() et format() sont les deux seules méthodes que vous devez appeler pour formater la devise FX.

L’API GlideCurrencyFormatter() fournit également des méthodes facultatives qui vous permettent d’effectuer les actions suivantes :

• Définissez les paramètres régionaux de la devise à l’aide de setLocale(). En définissant les paramètres régionaux, le formateur prend en compte toute mise en forme spécifique à ces paramètres régionaux, par exemple si une virgule décimale ou une virgule décimale est utilisée pour indiquer les fractions d’un montant monétaire. Par défaut : paramètres régionaux du système
• Définissez le nombre minimal de chiffres fractionnaires à afficher à l’aide de setMinFractionDigits(). Définit le nombre minimal de chiffres à droite de la virgule décimale à inclure. Par défaut, tous les chiffres transmis sont affichés. Si le montant transféré comporte moins de chiffres que le minimum spécifié, le résultat est complété par « 0 ».
• Définissez le nombre maximal de chiffres fractionnaires à afficher à l’aide de setMaxFractionDigits(). Définit le nombre maximal de chiffres à droite de la virgule décimale à inclure. Par défaut, tous les chiffres transmis sont affichés. Si le montant transféré a un nombre de chiffres supérieur au maximum spécifié, les chiffres supplémentaires sont tronqués au cours du processus d’arrondi au nombre de chiffres de fraction maximum. L’arrondi est effectué au chiffre le plus à droite le plus proche. Par exemple, si le chiffre de fraction maximal est défini sur 2 et que la valeur dans la devise transmise est 123,456, la valeur formatée est 123,46. Si la valeur de la devise est 23,122, la valeur formatée est 23,12. Si la valeur maximale est inférieure à la valeur minimale, la valeur minimale est utilisée.

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

GlideCurrencyFormatter : GlideCurrencyFormatter(String, formatString)

Instancie un objet GlideCurrencyFormatter et définit la chaîne de format à utiliser pour formater la devise FX.

Cette méthode n’exécute pas le format de chaîne réel. Vous devez appeler la méthode GlideCurrencyFormatter.format() pour formater la devise.

Tableau 1. Paramètres

Nom	Type	Description
formatChaîne	Chaîne	Facultatif. Chaîne de format à utiliser pour formater toute devise transmise dans le formateur. Valeurs valides : %s : remplacé par le symbole de devise associé au code de pays spécifié dans l’appel format ( ). %v : remplacé par le montant de la devise, par exemple 123,45. %c : remplacé par le code de devise ISO spécifié dans l’appel format ( ), tel que USD ou EUR. %l : remplacé par la valeur transmise, aucun formatage effectué. %p : remplacé par le signe de pourcentage ( %). Par exemple, si la chaîne de format est « %s %v %c » et que la valeur à formater est 123,45 en dollars américains, la chaîne formatée renvoyée est de 123,45 USD. Si la chaîne de format est ' %s %l %c’et que la chaîne de valeur à formater est '56M' en euros, la chaîne formatée renvoyée est de 56 millions d’euros. Remarque : La même chaîne de format est utilisée à chaque fois que la méthode format() est appelée sur cet objet.

Cet exemple montre comment appeler la méthode.

var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);

GlideCurrencyFormatter : format(valeur de chaîne, code de devise de chaîne)

Formate une valeur de devise spécifiée à l’aide du code de devise spécifié.

Le format de la devise qui en résulte dépend également des valeurs transmises lors de l’instanciation initiale de l’objet GlideCurrencyFormatter.

Tableau 2. Paramètres

Nom	Type	Description
valide	Chaîne	Montant de la devise au format. Le montant ne peut contenir qu’une décimale pour désigner le montant fractionnaire, les virgules ne sont pas prises en charge. Valeurs valides : 123,45 ou 2436,23 Valeurs non valides 123,45 ou 2 134,56
currencyCode	Chaîne	Code de devise ISO à trois lettres à utiliser lors du formatage de la devise.

Tableau 3. Renvoie

Type	Description
Chaîne	Valeur de devise formatée.

Cet exemple montre comment appeler la méthode.

var amount = '123456.123456789';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

Sortie :

Formatted currency: $123,456.12USD

GlideCurrencyFormatter : setLocale(String language, String country)

Définit la langue et le pays par défaut, qui constituent les paramètres régionaux, pour le formateur de devise.

Si vous n’appelez pas cette méthode avant d’appeler la méthode GlideCurrencyFormatter.format(), les paramètres régionaux sont définis par défaut sur les paramètres régionaux de la session en cours.

Tableau 4. Paramètres

Nom	Type	Description
language	Chaîne	Code de langue ISO 639 à deux lettres, tel que en, sp et fr.
pays	Chaîne	Code pays ISO 3166 à deux lettres, tel que US, ES et FR.

Tableau 5. Renvoie

Type	Description
nul

Cet exemple montre la définition du formateur de devise sur France.

var amount = '123456.123456789';
var currencyCode = 'EUR';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
exchangeValue.setLocale("fr", "FR"); // Language = fr Country = FR
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

Sortie :

Formatted currency: €123 456,12EUR

GlideCurrencyFormatter : setMaxFractionDigits(Number maxFractionDigits)

Définit le nombre maximal de chiffres à droite de la virgule décimale ou de la virgule décimale à renvoyer.

Tableau 6. Paramètres

Nom	Type	Description
maxFractionDigits	Numéro	Nombre maximal de chiffres de fraction à renvoyer. Si cette valeur est définie sur une valeur inférieure à la minFractionDigits valeur, elle est remplacée par minFractionDigits.

Tableau 7. Renvoie

Type	Description
nul

Cet exemple montre comment appeler la méthode.

var amount = '123456.123456789';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

Sortie :

Formatted currency: $123,456.12USD

GlideCurrencyFormatter : setMinFractionDigits(Number minFractionDigits)

Définit le nombre minimal de chiffres de fraction (à droite de la virgule décimale/virgule décimale) à renvoyer.

Tableau 8. Paramètres

Nom	Type	Description
minFractionDigits	Numéro	Nombre minimum de chiffres de fraction à renvoyer.

Tableau 9. Renvoie

Type	Description
nul

var amount = '123456.12';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMinFractionDigits(3).format(amount, currencyCode));

Sortie :

Formatted currency: $123,456.120USD