uCosminexus DocumentBroker Version 5 リファレンス API

[目次][用語][索引][前へ][次へ]

6.4.31 readProperties文書管理オブジェクトのプロパティ値の読み込み

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

Proxyオブジェクトのアクセス対象である文書管理オブジェクトの指定プロパティを,Proxyオブジェクトのプロパティに読み込みます。Proxyオブジェクトに読み込まれたプロパティ値集合は,DbjObj#propSetメソッドでDbjPropSetインターフェースを取得して参照できます。読み込まれたプロパティ値集合は,Proxyオブジェクトで保持しているプロパティ値集合に上書きして追加されます。

形式1では,Proxyオブジェクトの保持しているプロパティ値集合でのすべてのプロパティを文書管理オブジェクトから読み込みます。形式2では,読み込み対象のプロパティのコレクションを指定します。

(2) 形式

(a) 形式1
void readProperties()
(b) 形式2
void readProperties(
     Collection<String>     propDefs
)

(3) 引数

propDefs(入力)
要素はプロパティ名(String型)です。取得するプロパティのプロパティ名のコレクションを指定します。nullを指定すると例外がスローされます。

(4) 戻り値

なし

(5) 例外

DbjAccessControlException
アクセス権エラーの場合
DbjDBException
DBエラーの場合
DbjException
DocumentBrokerクラスライブラリ固有のエラーの場合
DbjNotCheckOutException
チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合
DbjObjectNotFoundException
指定オブジェクトが存在しなかった場合
DbjSessionNotConnectException
セッションが接続されていなかった場合
NullPointerException
引数propDefsがnullの場合