uCosminexus DocumentBroker Version 5 リファレンス API

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

5.14.6 setDeleteRootPath削除するディレクトリのルートパスの設定

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

(1) 機能

リファレンスファイル文書を削除する場合に,コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの,削除するディレクトリのルートパスを設定します。なお,指定した値の妥当性は,検証されません。

(2) 形式

void setDeleteRootPath(
                String  deleteRootPath
)

(3) 引数

deleteRootPath(入力)
リファレンスファイル文書を削除する場合に,コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの,削除するディレクトリのルートパスを指定します。
削除の対象となるディレクトリは,コンテンツロケーション(dbrProp_ContentLocationプロパティ)で示されるパス上の格納ディレクトリから,deleteRootPathプロパティで指定したディレクトリの下位までの間にあるディレクトリです。最下位層のディレクトリから順に削除し,エラーとなった時点で処理を終了します。
deleteRootPathプロパティに指定したパスがコンテンツロケーションのパスと一致していない場合はエラーになります。
nullを指定した場合,登録されているコンテンツ,およびDocumentBrokerがコンテンツを管理するためのディレクトリが削除されます。
なお,deleteRootPathプロパティの指定は,コンテンツが登録されているオブジェクトに対してだけ有効になります。
また,deleteRootPathプロパティに指定できるのは,DbjSession#setReferencePathメソッドで指定したコンテンツ格納先ベースパスから,コンテンツ格納先ベースパスとtargetPathプロパティで示されるコンテンツ格納先パスの間のパスです。コンテンツ格納先ベースパスより上位のパス,およびDocumentBrokerがコンテンツを管理するためのディレクトリのパスは指定できません。

(4) 戻り値

なし

(5) 例外

なし