使用可能メソッド

« オブジェクトの指定方法 | 式の組み立て »

設計者管理者

各オブジェクトで使用できるメソッドは、以下の通りです。

使用可能メソッド

ディメンション群

メソッド引数
（省略可の場合、[] で囲む）機能

メソッド	引数（省略可の場合、[] で囲む）	機能
item	第 1 引数 `文字列`: ディメンションラベル	指定されたラベルをもつディメンションを返します。 `Dimensions.item("#ACCOUNT")` は `Dimensions!#ACCOUNT` と同じ意味です。 Item メソッドに関する留意事項もご参照ください。
cur	（なし）	現在のディメンションを返します。`cur` はメンバリスト中のメンバ選択式内でのみ有効なオブジェクトを返します。返されるオブジェクトはそのメンバリストが適用されているディメンションです。 `Dimensions.cur` は `Dimensions!@cur` と同じ意味です。

item

第 1 引数: 文字列: ディメンションラベル

指定されたラベルをもつディメンションを返します。

Dimensions.item("#ACCOUNT") は Dimensions!#ACCOUNT と同じ意味です。
Item メソッドに関する留意事項もご参照ください。

cur

（なし）

現在のディメンション を返します。cur はメンバリスト中のメンバ選択式内でのみ有効なオブジェクトを返します。返されるオブジェクトはそのメンバリストが適用されているディメンションです。

Dimensions.cur は Dimensions!@cur と同じ意味です。

ディメンション

メソッド引数
（省略可の場合、[] で囲む）機能

メソッド	引数（省略可の場合、[] で囲む）	機能
label	（なし）	ディメンションのラベルを返します。
name	（なし）	ディメンションの名称を返します。
desc	（なし）	ディメンションの説明を返します。
item	第 1 引数 `文字列`: メンバラベル	指定されたラベルをもつメンバを返します。 `#ACCOUNT.item("SALES")` は `#ACCOUNT!SALES` と同じ意味です。 Item メソッドに関する留意事項もご参照ください。
cur	（なし）	現在のメンバを返します。 `#ACCOUNT.cur` は `#ACCOUNT!@cur` と同じ意味です。
pov	（なし）	視点メンバを返します。 `#ACCOUNT.pov` は `#ACCOUNT!@pov` と同じ意味です。
rkey	（なし）	責任範囲指定キーメンバを返します。 `#ACCOUNT.rkey` は `#ACCOUNT!@rkey` と同じ意味です。

label

（なし）

ディメンションのラベルを返します。

name

（なし）

ディメンションの名称を返します。

desc

（なし）

ディメンションの説明を返します。

item

第 1 引数: 文字列: メンバラベル

指定されたラベルをもつメンバを返します。

#ACCOUNT.item("SALES") は #ACCOUNT!SALES と同じ意味です。
Item メソッドに関する留意事項もご参照ください。

cur

（なし）

現在のメンバを返します。

#ACCOUNT.cur は #ACCOUNT!@cur と同じ意味です。

pov

（なし）

視点メンバを返します。

#ACCOUNT.pov は #ACCOUNT!@pov と同じ意味です。

rkey

（なし）

責任範囲指定キーメンバを返します。

#ACCOUNT.rkey は #ACCOUNT!@rkey と同じ意味です。

メンバ

メソッド引数
（省略可の場合、[] で囲む）機能

label

（なし）

メンバのラベルを返します。

name

（なし）

メンバの名称を返します。

desc

（なし）

メンバの説明を返します。

item

第 1 引数: 文字列: プロパティラベル

指定されたラベルをもつプロパティの値を返します。

#ACCOUNT!SALES.item("#ACTIVE") は #ACCOUNT!SALES!#ACTIVE と同じ意味です。
Item メソッドに関する留意事項もご参照ください。

is_child_of

第 1 引数: メンバオブジェクト

メソッド呼び出し先メンバが、引数で与えられたメンバの子（直下のメンバ）である場合 TRUE を返します。以外のときは FALSE を返します。

例）

  #ACCOUNT!@cur.is_child_of(#ACCOUNT!#SALES)  (1)

1	現在の勘定科目メンバが `SALES` というラベルを持つ勘定科目の子である場合にのみ `TRUE` を返します。

is_descendent_of

第 1 引数: メンバオブジェクト

メソッド呼び出し先メンバが、引数で与えられたメンバの子孫（自分自身及びその直接・間接の子）である場合 TRUE を返します。以外のときは FALSE を返します。

例）

  #ACCOUNT!@cur.is_descendent_of(#ACCOUNT!#SALES)  (1)

1	現在の勘定科目メンバが `SALES` というラベルを持つ勘定科目の子孫である場合にのみ `TRUE` を返します。

ancestor

第 1 引数: メンバオブジェクト: 共通祖先メンバオブジェクト
第 2 引数: 文字列: メンバ分類プロパティラベル
第 3 引数: 文字列: メンバ分類プロパティ値

メソッド呼び出し先メンバの祖先メンバ（自分自身及びその直接・間接の親）のうち、指定された条件を満たすメンバをひとつ返します。そのようなメンバが複数ある場合、そのうち最も下位にあるメンバを返します。

条件は、第 2 引数と第 3 引数で指定します。詳細はメンバ分類プロパティによるメンバ絞り込みをご覧ください。

例）

  DEPT!@cur.ancestor(DEPT!ALL, "DEPT_TYPE", "DIV") (1)

1	`部門/DEPT` ディメンションにおける現在のメンバの親メンバのうち `ALL` メンバ以下のメンバツリーに属し、かつ `部門タイプ/DEPT_TYPE` プロパティ値が `事業部/DIV` のメンバを返します。

lowest_common_ancestor

第 1 引数: メンバオブジェクト: メンバオブジェクト 1
第 2 引数: メンバオブジェクト: メンバオブジェクト 2
第 3 引数: 文字列: メンバ分類プロパティラベル
第 4 引数: 文字列: メンバ分類プロパティ値

特定のメンバツリー内で２つのメンバの共通の祖先メンバを検索して返します。このメソッドが適用されるメンバが、検索範囲であるメンバツリーの頂点です。

条件は、第 3 引数と第 4 引数で指定します。詳細はメンバ分類プロパティによるメンバ絞り込みをご覧ください。条件に合致するメンバが複数ある場合は、そのうち、最下位のものを返します。

例）

  DEPT!ALL.lowest_common_ancestor(DEPT!@CUR, DEPT!@POV, "#LEAF", "FALSE") (1)

1	`部門/DEPT` ディメンションにおける `ALL` メンバの子孫のうち、`DEPT!@CUR` と `DEPT!@POV` の共通の祖先で、かつリーフ区分プロパティ値が `リーフでない（FALSE）` であるメンバを返します。

shares_ancestors_with

第 1 引数: メンバオブジェクト
第 2 引数: 論理値: 検索対象をアクティブな先祖に限定するかどうかを指定する論理値
第 3 引数: 文字列: メンバ分類プロパティラベル
第 4 引数: 文字列: メンバ分類プロパティ値

メソッド呼び出し先メンバと、引数で与えられたメンバが、指定された条件を満たす共通の祖先メンバ（自分自身及びその直接・間接の親）を持つかどうかを判定します。条件に該当する祖先メンバが存在する場合 TRUE を返します。以外のときは FALSE を返します。

第 2 引数: 検索対象を 使用中 ^[1] の祖先に限定するとき TRUE を指定します。限定しないときは FALSE を指定します。

その他の条件は、第 3 引数と第 4 引数で指定します。詳細はメンバ分類プロパティによるメンバ絞り込みをご覧ください。

例）

  DEPT!@cur.shares_ancestors_with(DEPT!@pov, TRUE, "DEPT_TYPE", "DIV") (1)

1	`部門/DEPT` ディメンションにおける現在のメンバと視点メンバが、共通の事業部に属する場合のみ `TRUE` を返します。ただし `部門タイプ/DEPT_TYPE` プロパティ値が `事業部/DIV` なら、その部門は事業部である、という前提です。

1. 使用区分プロパティの値が「使用中」である意。

メンバ分類プロパティによるメンバ絞り込み

ディメンションメンバに関するメソッドのいくつかは、引数で与えられる メンバ分類プロパティラベル と メンバ分類プロパティ値 を用いて、対象メンバの絞り込みを行います。その際の絞り込み条件は以下の通りです：

メンバ分類プロパティラベルが空白値なら、絞り込みは行われません。
メンバ分類プロパティラベルに #LABEL と指定すると、メンバラベルを検査対象として絞り込みを行います。
以外の場合、メンバ分類プロパティラベルで指定されるプロパティの値を検査対象として絞り込みを行います。
検査においては、2 の場合、メンバのラベルが、また 3 の場合にはプロパティ値が、メンバ分類プロパティ値 に指定された値パターンと合致した場合、検査合格と判定します。メンバ分類プロパティ値 には、ワイルドカード文字 ? 及び * を使用できます。? は任意の 1 文字と合致し、* は任意の文字列と合致します。

異なるディメンションに属するメンバ間の関係の判定可否

メンバに関するメソッドのいくつかは、メンバ間の関係を判定します。これらのメソッドには、メソッドの適用対象及び引数として複数のメンバが与えられます。これら複数のメンバは、原則として同一のディメンションに属している必要があります。

ただし、上記の例外として、それら複数のメンバの属するディメンションの内容が同じである場合は、これらのメソッドで、異なるディメンションのメンバ間の関係を判定することが出来ます。なお、2 つのディメンションの「内容が同じ」とは、いずれかがいずれかを借用しているか、あるいは、両者が同一のディメンションを借用していることを言います。

これらのメソッドの返し値がメンバオブジェクトである場合もあります。その場合、返されるメンバオブジェクトの属するディメンションは、メソッドの適用対象であるメンバオブジェクトのディメンションとなります。

プロパティ

メソッド	引数（省略可の場合、[] で囲む）	機能
label	（なし）	プロパティ値のラベルを返します。
name	（なし）	プロパティ値の名称を返します。
desc	（なし）	プロパティ値の説明を返します。

メソッド

引数
（省略可の場合、[] で囲む）

機能

label

（なし）

プロパティ値のラベルを返します。

name

（なし）

プロパティ値の名称を返します。

desc

（なし）

プロパティ値の説明を返します。

元帳群

メソッド引数
（省略可の場合、[] で囲む）機能

メソッド	引数（省略可の場合、[] で囲む）	機能
item	第 1 引数 `文字列`: 元帳ラベル	指定されたラベルをもつ元帳を返します。 `Ledgers.item("PL")` は `Ledgers!PL` と同じ意味です。 Item メソッドに関する留意事項もご参照ください。
cur	（なし）	現在アクセス中のセルに結び付けられた元帳を返します。 `Ledgers.cur` は `Ledgers!@CUR` と同じ意味です。

item

第 1 引数: 文字列: 元帳ラベル

指定されたラベルをもつ元帳を返します。

Ledgers.item("PL") は Ledgers!PL と同じ意味です。
Item メソッドに関する留意事項もご参照ください。

cur

（なし）

現在アクセス中のセルに結び付けられた元帳を返します。

Ledgers.cur は Ledgers!@CUR と同じ意味です。

元帳

メソッド	引数（省略可の場合、[] で囲む）	機能
label	（なし）	元帳のラベルを返します。
name	（なし）	元帳の名称を返します。
desc	（なし）	元帳の説明を返します。

メソッド

引数
（省略可の場合、[] で囲む）

機能

label

（なし）

元帳のラベルを返します。

name

（なし）

元帳の名称を返します。

desc

（なし）

元帳の説明を返します。

元帳版群

メソッド引数
（省略可の場合、[] で囲む）機能

メソッド	引数（省略可の場合、[] で囲む）	機能
item	第 1 引数 `文字列`: 元帳版キー	指定された元帳版キーをもつ元帳版を返します。 `Editions.item("PUBLIC")` は `Editions!PUBLIC` と同じ意味です。 Item メソッドに関する留意事項もご参照ください。
cur	（なし）	現在アクセス中の元帳版を返します。 `Editions.cur` は `Editions!@CUR` と同じ意味です。

item

第 1 引数: 文字列: 元帳版キー

指定された元帳版キーをもつ元帳版を返します。

Editions.item("PUBLIC") は Editions!PUBLIC と同じ意味です。
Item メソッドに関する留意事項もご参照ください。

cur

（なし）

現在アクセス中の元帳版を返します。

Editions.cur は Editions!@CUR と同じ意味です。

元帳版

メソッド引数
（省略可の場合、[] で囲む）機能

メソッド	引数（省略可の場合、[] で囲む）	機能
key	（なし）	元帳版のキーを返します。
owner_label	（なし）	元帳版の所有者である業務責任単位のラベルを返します。具体的には、元帳版が、業務プロセス管理機能により生成された「各業務責任単位のワークスペース版」であるときのみ、ピリオドで元帳版キーを分割した場合の最後のパートを返します。それ以外の元帳版の場合、空文字列を返します。なお、提出パッケージの元帳版についても、当メソッドは空文字列を返す点にご留意ください。
is_submission	（なし）	元帳版が提出パッケージを表すものであるとき `TRUE` を、以外の時 `FALSE` を返します。

key

（なし）

元帳版のキーを返します。

owner_label

（なし）

元帳版の所有者である業務責任単位のラベルを返します。

具体的には、元帳版が、業務プロセス管理機能により生成された「各業務責任単位のワークスペース版」であるときのみ、ピリオドで元帳版キーを分割した場合の最後のパートを返します。それ以外の元帳版の場合、空文字列を返します。
なお、提出パッケージの元帳版についても、当メソッドは空文字列を返す点にご留意ください。

is_submission

（なし）

元帳版が提出パッケージを表すものであるとき TRUE を、以外の時 FALSE を返します。

セル範囲

メソッド引数
（省略可の場合、[] で囲む）機能

メソッド	引数（省略可の場合、[] で囲む）	機能
total	（なし）	セル範囲に含まれるドキュメントセルの値の集計値を返します。数値は借方+, 増加+ として集計し、範囲に数値以外があれば、エラー値 `#VALUE` を返します。範囲にエラー値 `#VALUE!`, `#N/A` 等が含まれていればそのエラー値が返されます。
max (fusion_place >= 10.0)	（なし）	セル範囲に含まれるドキュメントセルの値の最大値を返します。数値は借方+, 増加+ として判断します。範囲に数値以外がある場合、範囲にエラー値 `#VALUE!`, `#N/A` 等が含まれる場合、当該値はスキップします。
min (fusion_place >= 10.0)	（なし）	セル範囲に含まれるドキュメントセルの値の最小値を返します。数値は借方+, 増加+ として判断します。範囲に数値以外がある場合、範囲にエラー値 `#VALUE!`, `#N/A` 等が含まれる場合、当該値はスキップします。
is_empty	（なし）	セル範囲に含まれるすべてのセルが空である場合 `TRUE` を返し、以外の場合 `FALSE` を返します。数値セルは、値がゼロであるとき、またその時のみ空であるとみなされ、以外のセルは、値が空文字列であるとき、またその時のみ空であるとみなされます。
is_protected	（なし）	セル範囲に含まれるすべてのセルが入力不可である場合 `TRUE` を返し、以外の場合 `FALSE` を返します。
is_open	（なし）	セル範囲に含まれるすべてのセルについて、期間がオープンされている場合 `TRUE` を返し、以外の場合 `FALSE` を返します。
value	（なし）	セル範囲の左上隅のセルの値を返します。値が数値の場合は借方+, 増加+ として符号付けした値が返されます。表示されているテキスト値と符号が異なることがあるので注意して下さい。
text	（なし）	セル範囲の左上隅のセルに表示されているままの文字列値を返します。同セルの値が数値であっても、`text` メソッドは文字列値を返すので注意して下さい。
count (fusion_place >= 12.1)	（なし）	セル範囲に含まれるドキュメントセルの数値セルの個数を返します。範囲に数値以外があれば、当該値はスキップします。範囲にエラー値 `#VALUE!` , `#N/A` 等が含まれていればそのエラー値が返されます。ループ仕様の表示条件「データ無しのときは非表示」設定によって結果が変わりますので注意して下さい。
average (fusion_place >= 12.1)	（なし）	セル範囲に含まれるドキュメントセルの値の平均（算術平均）を返します。数値は借方+, 増加+ として集計し、範囲に数値以外があれば、エラー値 `#VALUE` を返します。範囲にエラー値 `#VALUE!`, `#N/A` 等が含まれていればそのエラー値が返されます。

total

（なし）

セル範囲に含まれるドキュメントセルの値の集計値を返します。数値は 借方+, 増加+ として集計し、範囲に数値以外があれば、エラー値 #VALUE を返します。範囲にエラー値 #VALUE!, #N/A 等が含まれていればそのエラー値が返されます。

max
(fusion_place >= 10.0)

（なし）

セル範囲に含まれるドキュメントセルの値の最大値を返します。数値は 借方+, 増加+ として判断します。範囲に数値以外がある場合、範囲にエラー値 #VALUE!, #N/A 等が含まれる場合、当該値はスキップします。

min
(fusion_place >= 10.0)

（なし）

セル範囲に含まれるドキュメントセルの値の最小値を返します。数値は 借方+, 増加+ として判断します。範囲に数値以外がある場合、範囲にエラー値 #VALUE!, #N/A 等が含まれる場合、当該値はスキップします。

is_empty

（なし）

セル範囲に含まれるすべてのセルが空である場合 TRUE を返し、以外の場合 FALSE を返します。
数値セルは、値がゼロであるとき、またその時のみ空であるとみなされ、以外のセルは、値が空文字列であるとき、またその時のみ空であるとみなされます。

is_protected

（なし）

セル範囲に含まれるすべてのセルが入力不可である場合 TRUE を返し、以外の場合 FALSE を返します。

is_open

（なし）

セル範囲に含まれるすべてのセルについて、期間がオープンされている場合 TRUE を返し、以外の場合 FALSE を返します。

value

（なし）

セル範囲の 左上隅のセルの値 を返します。値が数値の場合は 借方+, 増加+ として符号付けした値が返されます。表示されているテキスト値と符号が異なることがあるので注意して下さい。

text

（なし）

セル範囲の 左上隅のセルに表示されているままの文字列値 を返します。同セルの値が数値であっても、text メソッドは文字列値を返すので注意して下さい。

count
(fusion_place >= 12.1)

（なし）

セル範囲に含まれるドキュメントセルの数値セルの個数を返します。範囲に数値以外があれば、当該値はスキップします。範囲にエラー値 #VALUE! , #N/A 等が含まれていればそのエラー値が返されます。ループ仕様の表示条件「データ無しのときは非表示」設定によって結果が変わりますので注意して下さい。

average
(fusion_place >= 12.1)

（なし）

セル範囲に含まれるドキュメントセルの値の平均（算術平均）を返します。数値は 借方+, 増加+ として集計し、範囲に数値以外があれば、エラー値 #VALUE を返します。範囲にエラー値 #VALUE!, #N/A 等が含まれていればそのエラー値が返されます。

Item メソッドに関する留意事項

ディメンション群、ディメンション、メンバ、元帳群オブジェクトについては、 Item メソッドの引数に指定されたラベルをもつオブジェクトが存在しない場合、ラベル値が式の記述時に確定しているのであれば、式はエラーになります。以外の場合、 Item メソッド>は、実行時に、ラベルも名称も空文字列であるようなオブジェクトを返します。従って、返されたオブジェクトのラベルが空文字列であれば、引数で指定されたラベルをもつオブジェクトは存在しないと判断出来ます。

元帳版群オブジェクトの Item メソッドは、引数に指定された元帳版キーをもつ元帳版の存否に係わらず、その元帳版キーをもつ元帳版オブジェクトを返します（そのような元帳版が実際に生成されるわけではありません）。

オブジェクトの名称と言語について

fusion_place の各オブジェクトの名称は多言語です。テキスト式の name メソッドで返される名称は、そのうち「現在選択されている言語」について登録されている名称です。現在選択されている言語に関して名称が登録されていなければ、英語での名称が返されます。

「現在選択されている言語」は状況により異なります。名称が画面表示される場合、「現在の言語」は、メニューで選択されている 表示言語 です。サーバ側での処理などに際しては、クライアント側で指定された言語が適用される場合と、一律に、英語が適用される場合があります。それぞれの処理に関する解説において適宜触れていますので、ご留意ください。

元帳マスク、アクセス許可タイプ、フォームでの書き込み対象値の算出、バリデーションルール、インポート仕様での算出式など、データ表示以外の目的でテキスト式を使う場合、名称を使用することは推奨されません。

オブジェクトの「説明」について

オブジェクトの説明とは、オブジェクトのラベルと名称を適宜組合せて表示するものです。説明の表示方法は [マネージャ] / [ブラウザ] / [コントリビュータ] のメニューの オプション オブジェクト表示 で選択できます。画面表示に関わらない処理においては、説明としては名称が選択されているものとみなされます。サーバ側での計算処理などでは、この規則により常に名称が説明となるので、ご留意ください。説明の表示言語には名称と同じ規則が適用されます。

元帳マスク、アクセス許可タイプ、フォームでの書き込み対象値の算出、バリデーションルール、インポート仕様での算出式など、データ表示以外の目的でテキスト式を使う場合、説明を使用することは推奨されません。