20.2.6 Storeインタフェース
- 〈この項の構成〉
(1) 説明
ユーザファンクションの実行時にデータを操作するインタフェースです。
(2) インタフェース名
com.hitachi.software.xeads.func.store.Store
(3) メソッド一覧
Storeインタフェースが提供するメソッド一覧を次の表に示します。
|
メソッド名 |
説明 |
|---|---|
|
ユーザファンクションの実行時に，EADsクライアントで指定したグループを操作するためのインスタンスを取得します。 |
|
|
指定したグループを操作するためのインスタンスを取得します。 |
|
|
キャッシュ内の最上位階層のグループ名の一覧をASCIIコードの昇順で取得します。 |
|
|
指定したkeyに関連づけられたvalueが，キャッシュに格納されているかどうかを取得します。 |
(4) getGroup()
(a) 機能
ユーザファンクションの実行時に，EADsクライアントで指定したグループを操作するためのインスタンスを取得します。
(b) 形式
public Group getGroup()
(c) 戻り値
ユーザファンクションの実行時に，EADsクライアントで指定したグループを操作するためのインスタンスが返却されます。
EADsクライアントでグループを指定しなかった場合はnullが返却されます。
(5) getGroup()（グループ名指定）
(a) 機能
指定したグループを操作するためのインスタンスを取得します。
(b) 形式
public Group getGroup(String groupName)
throws EADsStoreException(c) パラメータ
- groupName
-
グループ名を指定します。
指定できるデータについては，「15.2.2(1) keyとして指定できるデータ」を参照してください。
なお，ユーザファンクションを実行中のEADsサーバに属していないグループ名を指定した場合は不正となります。
(d) 戻り値
指定したグループを操作するためのインスタンスが返却されます。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
InternalServerException（EADsサーバの内部エラー）
-
EADsStoreException（予期しないエラー）
(6) getGroupNameSet()
(a) 機能
キャッシュ内の最上位階層のグループ名の一覧をASCIIコードの昇順で取得します。
(b) 形式
public Set<String> getGroupNameSet()
throws EADsStoreException(c) 戻り値
キャッシュ内の最上位階層のグループ名の一覧（ASCIIコードの昇順）が返却されます。
(d) 発生する例外
-
EADsStoreException（予期しないエラー）
(7) containsKey()
(a) 機能
指定したkeyに関連づけられたvalueが，キャッシュに格納されているかどうかを取得します。
(b) 形式
public boolean containsKey(String key)
throws EADsStoreException(c) パラメータ
- key
-
確認対象のkeyを指定します。
指定できるデータについては，「15.2.2(1) keyとして指定できるデータ」を参照してください。
なお，ユーザファンクションを実行中のEADsサーバに，コピー元のデータが格納されていないkeyを指定した場合は不正となります。
(d) 戻り値
指定したkeyに関連づけられたvalueが，キャッシュに格納されているかどうかが返却されます。
- true
-
valueがキャッシュに格納されています。
- false
-
valueがキャッシュに格納されていません。
(e) 発生する例外
-
UserOperationException（ユーザの操作不正）
-
InternalServerException（EADsサーバの内部エラー）
-
EADsStoreException（予期しないエラー）