uCosminexus DocumentBroker Version 5 リファレンス API

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

6.4.39 writeProperties文書管理オブジェクトのプロパティ値の設定

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

(1) 機能

Proxyオブジェクトのアクセス対象である文書管理オブジェクトのプロパティ値を設定します。

形式1では,Proxyオブジェクトがアクセス対象とする文書管理オブジェクトのプロパティを,指定したプロパティ値集合で設定します。この場合,Proxyオブジェクトのプロパティ値集合は無視されます。形式2および形式3では,Proxyオブジェクトに設定されているプロパティ値集合で文書管理オブジェクトのプロパティを設定します。形式2では,DbjObj#readPropertiesメソッドで読み込んだプロパティ値集合のプロパティ値を書き換えて文書管理オブジェクトのプロパティ値を更新します。形式3では,Proxyオブジェクトに設定されているプロパティのうち,文書管理オブジェクトに反映するプロパティを限定して指定できます。なお,形式3の場合,指定した引数の値によってProxyオブジェクトの保持するプロパティ値集合は変更されません。

(2) 形式

(a) 形式1
void writeProperties(
     DbjPropSet     propSet
)
(b) 形式2
void writeProperties()
(c) 形式3
void writeProperties(
     Collection<String>     propDefs
)

(3) 引数

propSet(入力)
文書管理オブジェクトに設定するプロパティ値集合を指定します。nullを指定すると例外がスローされます。
propDefs(入力)
要素はプロパティ名(String型)です。文書管理オブジェクトに設定する対象になるプロパティ値のコレクションを指定します。Proxyオブジェクトのプロパティ値のコレクションに存在しないプロパティを指定した場合は無視されます。nullを指定すると例外がスローされます。

(4) 戻り値

なし

(5) 例外

DbjAccessControlException
アクセス権エラーの場合
DbjACEOperationException
指定ACEについてのエラーの場合
DbjDBException
DBエラーの場合
DbjException
DocumentBrokerクラスライブラリ固有のエラーの場合
DbjIllegalPropValException
指定プロパティ値が不正の場合
DbjNotCheckOutException
チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合
DbjObjectNotFoundException
指定オブジェクトが存在しなかった場合
DbjPublicACLNotFoundException
指定パブリックACLが存在しなかった場合
DbjPublicACLOutOfRangeException
指定パブリックACL数が範囲を超えた場合
DbjSessionNotConnectException
セッションが接続されていなかった場合
NullPointerException
引数propSet,またはpropDefsがnullの場合