GlideCurrencyConverter - スコープ付き

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：7分

    • GlideCurrencyConverter API は、米ドルから欧州ユーロへの変換など、ある通貨値を別の通貨値に変換するメソッドを提供します。

    GlideCurrencyConverter オブジェクトをインスタンス化し、インスタンス化の際に GlideCurrencyConverter(from, to) を使用してソース通貨と換算先通貨を定義できます。これらの値を指定せずにオブジェクトをインスタンス化し、後で setFromCurrency() および setToCurrency() メソッドを使用して定義することもできます。これらの値と換算対象の金額は、convert() メソッドを呼び出して通貨換算を実行する前に設定する必要があります。換算対象の金額を設定するには、setAmount() メソッドを使用します。

    GlideCurrencyConverter() API は、以下を可能にするオプションのメソッドも提供します。
    • 換算を実行する日時を設定します (setDateTime())。日時を設定すると、換算計算で使用されるレートは、デフォルトである現在の日時ではなく、指定された日時のレートになります。
    • 換算で使用するレートテーブルを設定します (setRateTable())。デフォルトでは fx_system_rate テーブルが使用されますが、インスタンスのカスタムレートテーブルを定義できます。レートテーブルの作成の詳細については、「 カスタムレートテーブルを使用して換算レートを追加する」を参照してください。

    このクラスは sn_currency 名前空間で実行されます。

    GlideCurrencyConverter - GlideCurrencyConverter()

    GlideCurrencyConverter オブジェクトをインスタンス化します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

    var conv = new sn_currency.GlideCurrencyConverter();

    GlideCurrencyConverter - GlideCurrencyConverter(文字列 from, 文字列 to)

    GlideCurrencyConverter オブジェクトをインスタンス化し、通貨換算で使用するソースおよび換算先の国コードを設定します。

    表 : 2. パラメーター
    名前 タイプ 説明
    コピー元 文字列 ソース通貨の 3 文字の ISO 3166 国コードです。
    to 文字列 換算先通貨の 3 文字の ISO 3166 国コードです。

    この例では、メソッドを呼び出す方法を示します。

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

    GlideCurrencyConverter - convert()

    通貨換算を実行します。

    このメソッドは、setAmount()、setRateTable()、setDate() など、通貨換算を構築する他の GlideCurrencyConverterメソッドを呼び出した後に呼び出します。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    オブジェクト 換算が成功した場合は、CurrencyExchangeValue オブジェクトを返します。失敗した場合は、null を返します。
    CurrencyExchangeValue {
Rate: Number,
OriginalAmount: Number,
Amount: Number,
fromCurrency: String,
toCurrency: String,
rateSysId: String
}

    Rate：数値。換算で使用される為替レートです。

    OriginalAmount：数値。ソース通貨の金額です。

    Amount：数値。換算後の金額です (OriginalAmount * Rate)。

    fromCurrency：文字列。ソース通貨の 3 文字の ISO 3166 国コードです。

    toCurrency：文字列。換算先通貨の 3 文字の ISO 3166 国コードです。

    rateSysId：文字列。換算の計算に使用されるレートテーブルレコードの sys_id です。

    この例では、メソッドを呼び出す方法を示します。

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

    出力:

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

    GlideCurrencyConverter - setAmount(文字列の金額)

    換算する通貨金額を設定します。

    表 : 5. パラメーター
    名前 タイプ 説明
    総計 文字列 換算する通貨金額です。この値は、小数点以下の通貨を表す場合を除き、書式設定なしにする必要があります。例えば、1234.56 は有効ですが、1,234.56 は無効です。
    表 : 6. 返される内容
    タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

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

    GlideCurrencyConverter - setDateTime(オブジェクト日付)

    通貨換算の日時を設定します。

    この日時により、通貨換算に使用される換算レートが決まります。このメソッドが GlideCurrencyConverter.convert() メソッドの前に呼び出されない場合、現在の日時のレートを使用して換算が実行されます。

    表 : 7. パラメーター
    名前 タイプ 説明
    日付 GlideDateTime 通貨換算を計算する日時です。この値は、換算で使用されるレートを決定します。
    表 : 8. 返される内容
    タイプ 説明
    なし

    次の例は、このメソッドを呼び出す方法を示しています。

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

    出力:

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

    GlideCurrencyConverter - setFromCurrency(文字列 from)

    ソース通貨の国コードを設定します。

    表 : 9. パラメーター
    名前 タイプ 説明
    コピー元 文字列 ソース通貨の 3 文字の ISO 3166 国コードです。
    表 : 10. 返される内容
    タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

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

    GlideCurrencyConverter - setRateTable(文字列 rateTable)

    通貨換算で使用するレートテーブルを定義します。

    GlideCurrencyConverter.convert() メソッドが呼び出される前にこのメソッドが呼び出されない場合、fx_system_rate テーブルを使用して換算が実行されます。すべてのカスタムレートテーブルは fx_conversion_rate テーブルを拡張する必要があります。レートテーブルの作成の詳細については、「 カスタムレートテーブルを使用して換算レートを追加する」を参照してください。

    表 : 11. パラメーター
    名前 タイプ 説明
    rateTable 文字列 通貨換算で使用するレートテーブルの名前です。
    表 : 12. 返される内容
    タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

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

    GlideCurrencyConverter - setToCurrency(文字列 to)

    換算先通貨の国コードを設定します。

    表 : 13. パラメーター
    名前 タイプ 説明
    to 文字列 ソース通貨の 3 文字の ISO 3166 国コードです。
    表 : 14. 返される内容
    タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

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