scmc.SCMCommonAPI

global with sharing class SCMCommonAPI

this class is used to support common helper methods across the scm product suite.

Financial Force, Inc.

2015

Methods

global static Integer getNumberDecimals()

Get the default number of decimals for the organization.

An interger that is the number of decimals set for the organization.

global static Decimal scaleAmount(Decimal amount)

Scale an amount to the number of decimals that is set for the organization.

Name	Type	Description
amount	Decimal	The amount that is to be scaled.

The original amount scaled to the number of decimals that is set for the organization.

global static String decimalFormatStringForLocale()

Create an editing map that reflects the number of decimals set for the organization. Will only work for US currency.

A valid String for displaying price or cost fields that will format a parameter with appropriate punctuation and decimals.

global static String formatDecimalForLocale(Decimal decimalValue)

Create an editing map that reflects the number of decimals set for the organization and the locale of the user.

Name	Type	Description
decimalValue	Decimal	Amount that is to be formatted.

A valid String of a decimal that is formatted with the appropriate punctuation and decimals.

global static Decimal convert(Decimal amount, String fromCurrency, String toCurrency, Boolean scale)

Convert an amount from one currency to another. The conversion uses the current exchange rate in the Salesforce multi-currency definition.

Name	Type	Description
amount	Decimal	The amount that is the value that you want to convert from one currency to another.
fromCurrency	String	The currency you are converting from. This is the name of a currency defined in Salesforce as a currency.
toCurrency	String	The currency you want to convert to. This is the name of a currency defined in Salesforce as a currency.
scale	Boolean	A boolean that indicates if you want the result of the conversion to be scaled to the organization number of decimals.

A Decimal value that is the amount you specified converted to the new currency.