GlideElementCurrency2 - スコープ対象

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む6読むのに数分
  • GlideElementCurrency2 API は、現在の GlideRecord 内の外国為替 (FX) 通貨フィールド (Currency2 とも呼ばれる) で操作を実行するメソッドを提供します。

    この API では、次の操作を実行できるようにするメソッドが提供されます。
    • ユーザーが入力した [FX 通貨] フィールドの表示文字列を取得する。
    • [FX 通貨] フィールドの表示値を取得する。
    • [FX 通貨] フィールドの基準通貨値を取得する。
    • [FX 通貨] フィールドのセッション通貨値を取得する。
    • [FX 通貨] フィールドの表示値を設定する。

    GlideElementCurrency2 クラスにはコンストラクターがありません。

    スコープ対象 GlideElementCurrency2 - getAsEnteredDisplayValue()

    関連する GlideRecord からユーザーが入力した [FX 通貨] フィールドの表示文字列を返します。

    FX 通貨フィールドの詳細については、「 FX 通貨フィールドの設定と操作」を参照してください。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし
    表 : 2. 返される内容
    タイプ 説明
    文字列 ユーザーが入力した通貨文字列を表示します。

    var tablename = 'my_currency2_table';
    var setcur2 = new GlideRecord(tablename);
    setcur2.initialize();
    setcur2.currency_2_field.setDisplayValue('JPY;999999.1234');
    setcur2.insert();
    gs.info('As entered display value: ' + setcur2.currency_2_field.getAsEnteredDisplayValue());

    出力:

    As entered display value: ¥999,999.12

    スコープ対象 GlideElementCurrency2 - getDisplayValue()

    関連する GlideRecord 内の [FX 通貨] フィールドの表示値を返します。

    FX 通貨構成 [fx_configuration] テーブルで display_value がどのように設定されているかに応じて、次のような値が返されます。
    • ユーザーが入力した通貨値
    • セッション通貨に換算された通貨値 (ユーザーのロケールに基づく)
    • 基準通貨に換算された通貨値

    FX 通貨と構成テーブルの詳細については、「 FX 通貨のグローバル設定を構成する」を参照してください。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    文字列 表示通貨値

    var tablename = 'my_FXcurrency_table';
    var setcur2 = new GlideRecord(tablename);
    setcur2.initialize();
    setcur2.currency_2_field.setDisplayValue('JPY;999999.1234');
    setcur2.insert();
    gs.info('Display Value: ' + setcur2.currency_2_field.getDisplayValue());

    出力:

    Display Value: ¥999,999.12

    スコープ対象 GlideElementCurrency2 - getReferenceDisplayValue()

    関連する GlideRecord 内の [FX 通貨] フィールドの基準通貨値を返します。

    基準通貨はフィールド内のすべての通貨値が換算される共通通貨です。getReferenceDisplayValue() メソッドが基準通貨を導出するために使用する通貨コードは、以下に基づいています。
    • インスタンスレコードが存在する場合、メソッドは FX 通貨 [fx_currency2_instance] テーブルの reference_currency フィールドの値を使用します。
    • インスタンスレコードが存在しない場合、メソッドはインスタンスレコードが最終的に作成されるときにインスタンスレコードに設定される基準通貨を使用します (次の順序)。
      • 設定する場合、FX 通貨構成 [fx_configuration] テーブルの reference_currency
      • 設定する場合、FX 通貨構成 [fx_configuration] テーブルの reference_currency_source
      • システムデフォルトであるシステム基準通貨。

    FX 通貨構成 [fx_configuration] テーブルの値の詳細については、「 FX 通貨フィールドの設定と操作」を参照してください。

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    文字列 関連する FX 通貨表示値の基準通貨金額。

    この例では、基準通貨コードは USD であり、FX 通貨構成 [fx_configuration] テーブルで指定されたデフォルトの換算レートを使用します。出力はロケールに基づいて変更されます。

    var tablename = 'my_currency2_table';
    var setcur2 = new GlideRecord(tablename);
    setcur2.initialize();
    setcur2.currency_2_field.setDisplayValue('JPY;999999.1234');
    setcur2.insert();
    gs.info('Reference display value: ' + setcur2.currency_2_field.getReferenceDisplayValue());

    出力:

    Reference display value: $8,677.99

    スコープ対象 GlideElementCurrency2 - getSessionDisplayValue()

    現在の GlideRecord 内の関連する [FX 通貨] フィールドの基準通貨値を返します。

    表 : 7. パラメーター
    名前 タイプ 説明
    なし
    表 : 8. 返される内容
    タイプ 説明
    文字列 現在のユーザーのロケールに基づくセッション通貨に換算された通貨値。

    この例では、セッションロケールの言語コードが eng、国コードが USA であることを想定し、FX 通貨構成 [fx_configuration] テーブルで指定されたデフォルトの換算レートを使用します。出力はロケールに基づいて変更されます。

    var tablename = 'my_currency2_table';
    var setcur2 = new GlideRecord(tablename);
    setcur2.initialize();
    setcur2.currency_2_field.setDisplayValue('JPY;999999.1234');
    setcur2.insert();
    gs.info('Session display value: ' + setcur2.currency_2_field.getSessionDisplayValue());

    出力:

    Session display value: $8,677.99

    スコープ対象 GlideElementCurrency2 - setDisplayValue(文字列 displayValue)

    [FX 通貨] フィールドの表示値を指定された通貨値で設定します。

    FX 通貨フィールドの詳細については、「 FX 通貨フィールドの設定と操作」を参照してください。

    表 : 9. パラメーター
    名前 タイプ 説明
    displayValue 文字列 形式 <通貨コード>;<通貨金額> で [FX 通貨] フィールドに設定する値。ユーザーのロケールで <通貨金額> フィールドを書式設定する必要があります。

    たとえば、ユーザーのロケールが USA/eng の場合、渡された <通貨金額> は 123.45 です。ユーザーのロケールが FRA/fre の場合、渡された <通貨金額> は 123,45 です。

    表 : 10. 返される内容
    タイプ 説明
    なし

    var tablename = 'my_FXcurrency_table';
    var setcur2 = new GlideRecord(tablename);
    setcur2.initialize();
    setcur2.currency_2_field.setDisplayValue('JPY;999,999.1234');
    setcur2.insert();