69 ファンクション・プロバイダ・リファレンス

この章では、一連のデフォルトの標準ファンクション・プロバイダおよびその関連メソッドについて説明します。

ファンクション・プロバイダのメソッドは、シナリオから起動され、データ・プロバイダから返されるデータを操作できます。この章で説明する一連の標準ファンクション・プロバイダは、WebCenter Portalにデフォルトで用意されており、データ・プロバイダから返される結果に対して、一般的に必要とされる操作を行います。

カスタム・ファンクション・プロバイダの実装の詳細は、第68章「カスタム・ファンクション・プロバイダの実装」を参照してください。

表69-1に、標準ファンクション・プロバイダのメソッドの様々なカテゴリを示します。

表69-1 標準ファンクション・プロバイダのカテゴリ

ファンクション・プロバイダのカテゴリ	説明
キャッシュ・メソッド	名前付きキャッシュに対する操作を行います。
マップ・メソッド	Mapオブジェクトを作成および更新します。
リスト・メソッド	Listオブジェクトを作成および更新します。
文字列メソッド	一般的な文字列操作を行います。
日付メソッド	Dateオブジェクトを作成および操作します。
システム・メソッド	出力操作を行います。
コレクション・メソッド	コレクション・オブジェクトを作成、更新および変換します。
セキュリティ・メソッド	特定のロールのユーザーかどうか判定します。
CMISメソッド	CMISプロバイダをサポートします。
アクティビティ・グラフ・メソッド	アクティビティ・グラフ・プロバイダをサポートします。
セキュリティ・メソッド	ユーザーおよびロールに関する情報を取得できます。

キャッシュ・メソッド

名前付きOracle Coherenceキャッシュ・オブジェクトに対する操作を行います。

表69-2 キャッシュ・メソッド

使用するメソッド	アクション
getCache	指定されたキャッシュ構成ファイル内のエントリを使用して、名前付きキャッシュを返します。
get	名前付きキャッシュ内のアドレス・キーの値を返します。
clear	名前付きキャッシュをクリアします。
getCustomCache	wcps-dataprovider-cache-config.xmlに構成された、カスタム・キャッシュを取得します。
getLargeCache	`wcps-dataprovider-cache-config.xml`に構成された、大容量のキャッシュを取得します。
getMediumCache	`wcps-dataprovider-cache-config.xml`に構成された、中容量のキャッシュを取得します。
getSmallCache	`wcps-dataprovider-cache-config.xml`に構成された、中容量のキャッシュを取得します。
put	名前付きキャッシュに値を設定します。

getCache

指定されたキャッシュ構成ファイル内のエントリを使用して、名前付きキャッシュを返します。

引数

cacheConfigFile: (String)キャッシュ構成XMLファイルの名前。カスタム・ファンクション・プロバイダの場合、この構成ファイルはアプリケーションのクラスパス内に存在する必要があります。言い換えると、コールする側のクラスパス内であれば、どこにあっても構いません。
cacheName: (String)このメソッドにより返されるキャッシュの名前。

式言語の形式

${cache:getCache(configFile,cacheName)}

戻り値

com.tangosol.net.NamedCache

例

${cache:getCache('my-config.xml','mycache')}

使用上の注意

なし。

get

指定されたキーのキャッシュのマップ先の値を返します。

引数

cacheName: (com.tangosol.net.NamedCache)キャッシュ・オブジェクト。
key: (Object)名前付きキャッシュ内のアドレスの値へのキー。

式言語の形式

${cache:getCache(cache, key)}

戻り値

(Object)指定されたキーのキャッシュのマップ先の値。

例

${cache:get(mycache, aKey)}

使用上の注意

なし。

clear

名前付きキャッシュをクリアします。

引数

cacheName: (com.tangosol.net.NamedCache)キャッシュ・オブジェクト。

式言語の形式

${cache:getCache(cacheName)}

例

${cache:clear(aCache)}

使用上の注意

なし。

getCustomCache

wcps-dataprovider-cache-config.xmlに構成された、カスタム・キャッシュを取得します。

引数

cacheName: (String) wcps-dataprovider-cache-config.xmlに構成されたキャッシュの名前。

式言語の形式

${cache:getCache("cacheName")}

(Object)指定されたキーのキャッシュのマップ先の値。

戻り値

(com.tangosol.net.NamedCache)キャッシュ・オブジェクト。

例

${cache:clear("aCache")}

使用上の注意

なし。

getLargeCache

wcps-dataprovider-cache-config.xmlに構成された、大容量のキャッシュを取得します。デフォルトのキャッシュ・パラメータは、次のとおりです。

10000エントリ
1時間のTTL

引数

cacheName: (String) wcps-dataprovider-cache-config.xmlに構成された大容量のキャッシュの名前。

式言語の形式

${cache:getLargeCache("cacheName")}

戻り値

(com.tangosol.net.NamedCache) wcps-dp-large-<cacheName>という名前のキャッシュ・オブジェクト。

例

${cache:getLargeCache("aLargeCache")}

使用上の注意

なし。

getMediumCache

wcps-dataprovider-cache-config.xmlに構成された、中容量のキャッシュを取得します。デフォルトのキャッシュ・パラメータは、次のとおりです。

1000エントリ
1時間のTTL

引数

cacheName: (String) wcps-dataprovider-cache-config.xmlに構成された中容量のキャッシュの名前。

式言語の形式

${cache:getMediumCache("cacheName")}

戻り値

(com.tangosol.net.NamedCache) wcps-dp-medium-<cacheName>という名前のキャッシュ・オブジェクト。

例

${cache:getMediumCache("aMediumCache")}

使用上の注意

なし。

getSmallCache

wcps-dataprovider-cache-config.xmlに構成された、小容量のキャッシュを取得します。デフォルトのキャッシュ・パラメータは、次のとおりです。

100エントリ
1時間のTTL

引数

cacheName: (String) wcps-dataprovider-cache-config.xmlに構成された小容量のキャッシュの名前。

式言語の形式

${cache:getSmallCache("cacheName")}

戻り値

(com.tangosol.net.NamedCache) wcps-dp-small-<cacheName>という名前のキャッシュ・オブジェクト。

例

${cache:getSmallCache("aSmallCache")}

使用上の注意

なし。

put

名前付きキャッシュに値を設定します。

引数

cache: (com.tangosol.net.NamedCache)キャッシュ・オブジェクト。

key: (java.lang.Object)保存されたオブジェクトを識別するためのキー。

value: (java.lang.Object)キャッシュ対象のオブジェクト。

式言語の形式

${cache:put(aCache, aKey, aValue)}

戻り値

void

例

${cache:put(myCache, myKey, myValue)}

使用上の注意

なし。

マップ・メソッド

Mapオブジェクトを操作するユーティリティ・メソッドです。

表69-3 マップ・メソッド

使用するメソッド	アクション
new	新規HashMapオブジェクトを作成して返します。
put	キー/値ペアの既存のマップにエントリを設定します。
size	マップ内のエントリ数を返します。
keyset	マップ内のキーのコレクションを返します。
values	Mapオブジェクト内の値のコレクションを返します。
get	キーに関連付けられた、Mapオブジェクトからの値を返します。

new

新規HashMapオブジェクトを作成して返します。

引数

なし。

式言語の形式

${maps:new()}

戻り値

java.util.HashMap

例

${maps:new()}

使用上の注意

なし。

put

キー/値ペアの既存のマップにエントリを設定します。

引数

map: HashMapの名前。
key: キー・オブジェクト。
value: キーに対してマップされた値。

式言語の形式

${maps:put(map,key,value)}

戻り値

新規Mapオブジェクトを返します(java.util.Map)。

例

${maps:put(existingMap, keyObj, aValue)}

使用上の注意

なし。

size

マップ内のエントリ数を返します。

引数

map: (java.util.Map) Mapオブジェクト。

式言語の形式

${maps:size(aMap)}

戻り値

int

例

${maps:size(aMap)}

使用上の注意

なし。

keyset

マップ内のキーのコレクションを返します。

引数

map: (java.util.Map) Mapオブジェクト。

式言語の形式

${maps:put(map)}

戻り値

java.util.Set

例

${maps:keyset(aMap)}

使用上の注意

なし。

values

Mapオブジェクト内の値のコレクションを返します。

引数

map: (java.util.Map) Mapオブジェクト。
key: (java.lang.Object)キー・オブジェクト。
value: (<V>)キーに対してマップされた値。

式言語の形式

${maps:values(map)}

戻り値

java.util.Collection

例

${maps:values(aMap)}

使用上の注意

なし。

get

キーに関連付けられた、Mapオブジェクトからの値を返します。

引数

map: (java.util.Map) Mapオブジェクト。
key: (java.lang.Object)キー・オブジェクト。

式言語の形式

${maps:put(map,key)}

戻り値

<V>型の値。

例

${maps:put(aMap, aKey)}

使用上の注意

なし。

withEntries

指定されたキー/値ペアが移入された、HashMapを作成します。

引数

key: (String)キー。

value: (String)値。

式言語の形式

${maps:withEntries(keyvaluepairs)}

戻り値

java.util.Map

使用上の注意

なし。

リスト・メソッド

オブジェクトのリストの作成およびオブジェクトのリストへの追加を行います。

表69-4 リスト・メソッド

使用するメソッド	アクション
new	新規ArrayListオブジェクトを作成して返します。
add	リストにオブジェクトを追加します。
size	Listオブジェクト内の要素の数を返します。

new

新規ArrayListオブジェクトを作成して返します。

引数

なし。

式言語の形式

${list:new()}

戻り値

java.util.ArrayList

例

${list:new()}

使用上の注意

なし。

add

リストにオブジェクトを追加します。

引数

list: (java.util.List) List型のオブジェクト。
value: (java.lang.Object)リストに追加する値。

式言語の形式

${list:add(list,value)}

戻り値

java.lang.Boolean

例

${list.add(existingList, aValue)}

使用上の注意

なし。

size

Listオブジェクト内の要素の数を返します。

引数

list: (java.util.List) Listオブジェクト。

式言語の形式

${list:size(list)}

戻り値

int

例

${list:size(mylist)}

使用上の注意

なし。

文字列メソッド

文字列に対する基本的なユーティリティ機能を実行します。

表69-5 文字列メソッド

使用するメソッド	アクション
concat	2つの文字列を連結し、新規Stringオブジェクトを返します。
contains	この文字列に指定された文字列が含まれる場合、trueを返します。
indexOf	この文字列内で、指定された部分文字列が最初に見つかったインデックスを返します。
join	指定されたコレクション内のStringオブジェクトを結合し、指定されたデリミタで区切った、新しい文字列を返します。
replaceAll	この文字列の、指定された正規表現と一致する各部分文字列を、指定された置換文字列で置き換えます。
split	この文字列を、指定された正規表現に一致する前後で分割します。
startsWith	この文字列が、指定された接頭辞で始まるかどうかをテストします。
endsWith	この文字列が、指定された接頭辞で終わるかどうかをテストします。
substring	この文字列の部分文字列である、新しい文字列を返します。

concat

2つの文字列を連結し、新規Stringオブジェクトを返します。

引数

stringA: (java.lang.String)連結先の文字列。
stringB: (java.lang.String) stringAの最後に連結する文字列。

式言語の形式

${string:concat(stringA,stringB)}

戻り値

java.lang.String

例

${cache:getCache("Hello, ","world!")}

使用上の注意

なし。

contains

この文字列に指定された文字列が含まれる場合、trueを返します。

引数

string: (java.lang.String)検索対象の文字列。
containsString: (java.lang.String)検索する文字列。

式言語の形式

${string:contains(string,containsString)}

戻り値

java.lang.Boolean

例

${cache:getCache("the quick brown fox","fox")}

使用上の注意

なし。

indexOf

この文字列内で、指定された部分文字列が最初に見つかったインデックスを返します。

引数

string: (java.lang.String)部分文字列の検索対象の文字列。
substring: (java.lang.String)検索する部分文字列。

式言語の形式

${string:indexOf(string,substring)}

戻り値

int

例

${cache:getCache("the quick brown fox", "quick")}

使用上の注意

なし。

join

指定されたコレクション内のStringオブジェクトを結合し、指定されたデリミタで区切った、新しい文字列を返します。

引数

collection: 文字列を含むコレクション・オブジェクト。
delimiter: 入力文字列の値の分割に使用される、文字列トークン。

式言語の形式

${string:join(collection,delimiter)}

戻り値

java.lang.String

例

${cache:getCache(aCollection,', ')}

使用上の注意

なし。

replaceAll

この文字列の、指定された正規表現と一致する各部分文字列を、指定された置換文字列で置き換えます。

引数

string: 元のStringオブジェクト。
regex: 部分文字列の識別に使用される、正規表現。
replacementString: 元の文字列入力変数を置き換える文字列。

式言語の形式

${string:replaceAll(string,regex,replacementString)}

戻り値

java.lang.String

例

${cache:getCache("SomeSimpleString, "Simple", "Complex")}

使用上の注意

なし。

split

この文字列を、指定された正規表現に一致する前後で分割します。

引数

string: 分割対象のStringオブジェクト。
splitToken: 入力文字列パラメータの分割に使用されるトークン文字列。

式言語の形式

${string:split(string,splitToken)}

戻り値

java.lang.String

例

${cache:getCache("one, two, three"), ",")}

使用上の注意

なし。

startsWith

この文字列が、指定された接頭辞で始まるかどうかをテストします。

引数

string: テスト対象の文字列。
start: テスト用の文字列。

式言語の形式

${string:startsWith(string,start)}

戻り値

(java.lang.Boolean)入力文字列がテスト用の文字列で始まる場合、trueを返します。

例

${cache:getCache("BeginString", "Begin")}

使用上の注意

なし。

endsWith

この文字列が、指定された接頭辞で終わるかどうかをテストします。

引数

string: テスト対象の文字列。
start: テスト用の文字列。

式言語の形式

${string:startsWith(string,end)}

戻り値

(java.lang.Boolean)入力文字列がテスト用の文字列で始まる場合、trueを返します。

例

${cache:getCache("StringEnd", "End")}

使用上の注意

なし。

substring

この文字列の部分文字列である、新しい文字列を返します。

引数

inputString: 文字列のサブセット。
startIndex: それ自身を含む、開始インデックス。
endIndex: それ自身を含む、終了インデックス。

式言語の形式

${string:startsWith(string,end)}

戻り値

(java.lang.Boolean)入力文字列がテスト用の文字列で始まる場合、trueを返します。

例

${cache:getCache("The quick brown fox", 1, 10)}

使用上の注意

なし。

日付メソッド

Dateオブジェクトを処理するユーティリティ・メソッドです。

表69-6 日付メソッド

使用するメソッド	アクション
after	この日付が指定された日付より後かどうかをテストします。
before	この日付が指定された日付より後かどうかをテストします。
diffDates	指定された測定単位による、2つの日付間の差(日付1 – 日付2)を返します。
diffFromNow	指定された測定単位による、本日の日付と指定された日付の間の差を返します。
format	入力された日付を、指定された書式文字列で書式設定します。
new	現在の日時を使用して新しい日付を返します。

after

この日付が指定された日付より後かどうかをテストします。

引数

date1: (java.util.Date)テスト対象の1番目の日付。
date2: (java.util.Date)テスト対象の2番目の日付。

式言語の形式

${date:after(date1,date2)}

戻り値

(java.lang.Boolean) 2番目の日付が1番目の日付より後の場合、trueを返します。

例

${date:after(aDate, bDate)}

使用上の注意

なし。

before

この日付が指定された日付より前かどうかをテストします。

引数

date1: (java.util.Date)テスト対象の1番目の日付。
date2: (java.util.Date)テスト対象の2番目の日付。

式言語の形式

${date:after(date1,date2)}

戻り値

(java.lang.Boolean) 2番目の日付が1番目の日付より前の場合、trueを返します。

例

${date:before(aDate, bDate)}

使用上の注意

なし。

diffDates

指定された測定単位による、2つの日付間の差(日付1 – 日付2)を返します。

引数

date1

テスト対象の1番目の日付。

date

テスト対象の2番目の日付。

units

(String)有効な単位は次のとおりです。

表69-7 unitsパラメータの有効値

単位	説明
y	年
M	年における月
w	年における週
d	年における日
m	分
s	秒
l	ミリ秒

式言語の形式

${date:diffDates(date1,date2,units)}

戻り値

(int)入力された単位で指定されたとおりに算出された、2つの日付間の差です。たとえば、入力された単位がyの場合、結果は2つの日付の間隔の年数になります。

例

${date:diffDates(aDate, bDate, "M")}

使用上の注意

なし。

diffFromNow

指定された測定単位による、本日の日付と指定された日付の間の差を返します。

引数

date1

(java.util.Date)テスト対象の日付。

units

(String)有効な単位は次のとおりです。

表69-8 unitsパラメータの有効値

単位	説明
y	年
M	年における月
w	年における週
d	年における日
m	分
s	秒
l	ミリ秒

式言語の形式

${date:diffFromNow(date1,date2,units)}

戻り値

例

${date:diffFromNow(aDate, bDate, "M")}

使用上の注意

なし。

format

入力された日付を、指定された書式文字列で書式設定します。

引数

date: (java.util.Date)書式設定の対象の日付。
pattern: 日付を書式設定するための日付パターン。

式言語の形式

${date:format(date,pattern)}

戻り値

java.lang.String

例

${date:format(aDate, "yyyy-MM-dd")}

使用上の注意

なし。

new

現在の日時を使用して新しい日付を返します。

引数

なし。

式言語の形式

${date:new()}

戻り値

java.lang.Date

例

${date:new()}

使用上の注意

なし。

システム・メソッド

標準の出力メソッドを提供します。

表69-9 システム・メソッド

使用するメソッド	アクション
print	標準エラー出力または標準コンソールのいずれかに、オブジェクトを出力します。
println	標準エラー出力または標準コンソールのいずれかに、オブジェクトを改行して出力します。

print

オブジェクトを出力します。

引数

stream: (String) 標準エラー出力ストリームに出力する場合はerrを、標準コンソールに出力する場合はoutを指定します。
object: (java.lang.Object)出力対象のオブジェクト。

式言語の形式

${system:print(stream,object)}

戻り値

void

例

${cache:getCache("err", "Hello, world!")}

使用上の注意

outオプションを指定した場合はWC_Utilities.outファイルに、errオプションを指定した場合はWC_Utilities.errファイルにそれぞれ出力されます。これらのファイルは、サーバーのドメイン・ディレクトリに配置されています。

println

オブジェクトを改行して出力します。

引数

stream: (String) 標準エラー出力ストリームに出力する場合はerrを、標準コンソールに出力する場合はoutを指定します。
object: (java.lang.Object)出力対象のオブジェクト。

式言語の形式

${system:println(stream,object)}

戻り値

void

例

${cache:println("out", "Hello, world!")}

使用上の注意

セキュリティ・メソッド

ユーザーおよびロールに関する情報を検索できます。

表69-10 セキュリティ・メソッド

使用するメソッド	アクション
getUserRoles	現在の対象の一部である、ロール/グループの配列を返します。
isUserInRole	現在のユーザーが、指定されたロール名またはグループ名のメンバーかどうかを判定します。

getUserRoles

現在の対象の一部である、ロール/グループの配列を返します。

引数

なし。

式言語の形式

${security:getUserRoles()}

戻り値

java.util.List

例

${security:getUserRoles()}

使用上の注意

なし。

isUserInRole

現在のユーザーが、指定されたロール名またはグループ名のメンバーかどうかを判定します。

引数

role: (String)ロールまたはグループの名前

式言語の形式

${security:isUserInRole(role)}

戻り値

Boolean

例

${security:isUserInRole("Moderator")}

使用上の注意

なし。

コレクション・メソッド

コレクション・オブジェクトに対する操作を行います。

表69-11 コレクション・メソッド

使用するメソッド	アクション
append
fromArray
size
sort	オブジェクトのコレクションにオブジェクトを追加します。
toArray	コレクションに由来する、オブジェクトの配列を返します。
fromArray	オブジェクトの配列の中のオブジェクトが格納された、Listオブジェクトを返します。
size	コレクションのサイズを判定します。コレクションがnullの場合、0(ゼロ)が返されます。
sort	リストの要素の自然順により、指定されたリストを昇順にソートします。
new	新規Collectionオブジェクトを返します。

append

オブジェクトのコレクションにオブジェクトを追加します。

引数

collection: (java.util.Collection) Collectionオブジェクト。
item: (java.lang.Object)コレクションへの追加対象のオブジェクト。

式言語の形式

${collections:append(collection,item)}

戻り値

java.util.Collection

例

${collections:append(aCollection, anObject)}

使用上の注意

なし。

toArray

コレクションに由来する、オブジェクトの配列を返します。

引数

collection: (java.util.Collection)オブジェクトの配列になるCollectionオブジェクト。

式言語の形式

${collections:toArray(collection)}

戻り値

java.lang.Object

例

${cache:getCache(aCollection)}

使用上の注意

なし。

fromArray

オブジェクトの配列の中のオブジェクトが格納された、Listオブジェクトを返します。

引数

array: (java.lang.Object[])オブジェクトの配列。

式言語の形式

${collections:fromArray(array)}

戻り値

java.util.Collection

例

${collections:fromArray(anArray)}

使用上の注意

なし。

size

コレクションのサイズを判定します。コレクションがnullの場合、0(ゼロ)が返されます。

引数

collection: (java.util.Collection) Collectionオブジェクト。

式言語の形式

${collections:size(collection)}

戻り値

long

例

${collections:size(aCollection)}

使用上の注意

なし。

sort

リストの要素の自然順により、指定されたリストを昇順にソートします。

引数

list: (java.util.List)ソート対象のListオブジェクト。

式言語の形式

${collections:sort(list)}

戻り値

void

例

${collections:sort(myList)}

使用上の注意

なし。

new

新規Collectionオブジェクトを返します。

引数

なし。

式言語の形式

${collections:new()}

戻り値

java.lang.Collection

例

${collections:new()}

使用上の注意

なし。

アクティビティ・グラフ・メソッド

アクティビティ・グラフに対する操作を行います。

表69-12 アクティビティ・グラフ・メソッド

使用するメソッド	アクション
filterRecsByScore	スコア>=入力スコアの推奨事項を選別します。
getCMISLinksFromCommonItems	共通のアイテムをCMISオブジェクトとして表している、URLのリストを返します。
getCMISLinksFromRecommendations	CMISオブジェクトを表すURLのリストを返します。
getContentIDs	入力オブジェクトから、コンテンツIDを抽出します。すべてのタイプのコンテンツを含みます(WC.document, WC.wiki)。
getContentIDsExclude	入力オブジェクトから、コンテンツIDを抽出します。
getContentIDsFiltered	入力オブジェクトから、コンテンツIDを抽出します。

filterRecsByScore

スコア>=入力スコアの推奨事項を選別します。

cutoffScore以上の推奨事項のみを返します。

引数

recommendations: (java.util.Collection) Collectionオブジェクト。
cutoffScore: (float)カットオフ・スコア。

式言語の形式

${agfunction:filterRecsByScore(recommendations,cutoffScore)}

戻り値

oracle.wcps.activity.agrest.spy.jaxb.Recommendations

使用上の注意

なし。

getCMISLinksFromCommonItems

共通のアイテム内の実際のコンテンツ・アイテムをCMISオブジェクトとして表している、クリック可能なURLのリストを返します。

引数

results: (oracle.wcps.activity.agrest.spy.jaxb.Results)

式言語の形式

${agfunction:getCMISLinksFromCommonItems(results)}

戻り値

 java.util.List

使用上の注意

なし。

getCMISLinksFromRecommendations

推奨事項内の実際のコンテンツ・アイテムを表している、クリック可能なURLのリストを返します。

引数

recommendation: (oracle.wcps.activity.agrest.spy.jaxb.Recommendations)

式言語の形式

${agfunction:getCMISLinksFromRecommendations(recommendations)}

戻り値

java.util.List

使用上の注意

なし。

getContentIDs

入力オブジェクトから、コンテンツIDを抽出します。すべてのタイプのコンテンツを含みます(WC.document, WC.wiki)。

推奨事項の結果の中から、短縮バージョンのコンテンツ識別子を返します。パラメータagResultsは、次のいずれかになります。

Recommendations
RecommendedItems
List<Recommendation>

引数

agResults: (java.lang.Object)

式言語の形式

${agfunction:getContentIDs(agResults)}

戻り値

java.util.List

使用上の注意

なし。

getContentIDsExclude

推奨事項の結果の中から、短縮バージョンのコンテンツ識別子を返します。結果から、excludeClassURNを除外します。パラメータagResultsは、次のいずれかになります。

Recommendations
RecommendedItems
List<Recommendations>

引数

agResults: (java.lang.Object)

式言語の形式

${agfunction:getContentIDsExclude(agResults,excludeClassURN)}

戻り値

java.util.List

使用上の注意

なし。

getContentIDsFiltered

推奨事項の結果の中から、短縮バージョンのコンテンツ識別子を返します。classURNに対応するIDのみを返します。ClassURNの詳細は、このブログの命名体系に関する項を参照してください。パラメータagResultsは、次のいずれかになります。

Recommendations
RecommendedItems
List<Recommendations>

引数

agResults: (java.lang.Object)

filterClassURN: (java.lang.String)

式言語の形式

${agfunction:getContentIDsFiltered(agResults,filterClassURN)}

戻り値

java.util.List

使用上の注意

なし。

CMISメソッド

CMISに対する操作を行います。

表69-13 CMISメソッド

使用するメソッド	アクション
getCMISLinksFromCommonItems	共通のアイテムをCMISオブジェクトとして表している、URLのリストを返します。
getCMISLinksFromRecommendations	CMISオブジェクトを表すURLのリストを返します。
getContentIDs	入力オブジェクトから、コンテンツIDを抽出します。すべてのタイプのコンテンツを含みます(WC.document, WC.wiki)。
getContentIDsExclude	入力オブジェクトから、コンテンツIDを抽出します。
getContentIDsFiltered	入力オブジェクトから、コンテンツIDを抽出します。
atomAsCMISObjects	List<CMISObject>としてのATOMフィード。
atomAsEntries	List<org.apache.abdera.model.Entry>としてのATOMフィード。
atomAsFeed	org.apache.abdera.model.FeedとしてのATOMフィード。
atomAsStreamUrls	URLのList<String>としてのATOMフィード。
getCMISQueryForDocIDs	CMIS問合せをIN問合せ構文の形式で作成します。これにより、入力ドキュメントIDの配列用のドキュメントが取得されます。
getCMISQueryForDocIDsFromFullID	CMIS問合せをIN問合せ構文の形式で作成します。これにより、入力ドキュメントIDの配列用のドキュメントが取得されます。

atomAsCMISObjects

CMISオブジェクトはマーシャリングできないため、このメソッドをJavaクライアントのコードで使用して、ATOM問合せの結果をList<CMISObject>に変換します。

引数

atomFeed: (java.lang.String) Collectionオブジェクト。
cutoffScore: (float)カットオフ・スコア。

式言語の形式

${cmisfunction:atomAsCMISObjects(atomFeed)}

戻り値

java.util.List

使用上の注意

なし。

atomAsEntries

org.apache.abdera.model.Entry (Abderaフィード上の属性)はマーシャリングできないため、このメソッドをJavaクライアントのコードで使用して、ATOM問合せの結果をList<org.apache.abdera.model.Entry>に変換します。

引数

atomFeed: (String)

式言語の形式

${cmisfunction:atomAsEntries(atomFeed)}

戻り値

java.util.List

使用上の注意

なし。

atomAsFeed

org.apache.abdera.model.Feedはマーシャリングできないため、このメソッドをJavaクライアントのコードで使用して、ATOM問合せの結果をList<org.apache.abdera.model.Feed>に変換します。

引数

atomFeed: (String)

式言語の形式

${cmisfunction:atomAsFeed(atomFeed)}

戻り値

java.util.List

使用上の注意

なし。

atomAsStreamUrls

ATOMフィードをURLのList<String>として返します。

引数

atomFeed: (String)

式言語の形式

${agfunction:getContentIDs(agResults)}

戻り値

java.util.List

使用上の注意

なし。

getCMISQueryForDocIDs

CMIS問合せをIN問合せ構文の形式で作成します。これにより、入力ドキュメントIDの配列用のドキュメントが取得されます。

引数

repository: (String)

ids: (java.util.List)

式言語の形式

${agfunction:getContentIDsExclude(agResults,excludeClassURN)}

戻り値

String

使用上の注意

なし。

getCMISQueryForDocIDsFromFullID

CMIS問合せをIN問合せ構文の形式で作成します。これにより、入力ドキュメントIDの配列用のドキュメントが取得されます。

このメソッドにより、IDのリスト(おそらく、アクティビティ・グラフ・プロバイダで取得されたもの)が、CMIS問合せ文字列に変換され、複数のコンテンツ・アイテムが取得されます。このIDは、my-ucm11g#dDocName:MOUNTAINSのような、WebCenter IDの形式になっています。

引数

ids: (java.util.List)

式言語の形式

${cmisfunction:getCMISQueryForDocIDsFromFullID(ids)}

戻り値

String

使用上の注意

なし。