uCosminexus DocumentBroker Version 5 リファレンス API

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

6.4.32 removeObject文書管理オブジェクトの削除

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

(1) 機能

Proxyオブジェクトのアクセス対象の文書管理オブジェクトを削除します。

形式2では,フォルダの削除の場合は直接型リンクが設定されているすべてのリンク先オブジェクトを削除します。

形式3では,リファレンスファイル管理機能を使用したオブジェクトを削除すると同時に,コンテンツを格納していたフォルダを削除できます。

なお,デッドロックを防止するため,リンク先オブジェクトを削除する場合は,リンク元オブジェクトを削除するまたはリンク元オブジェクトにwriteロックします。このメソッドの実行時に,文書管理オブジェクトが存在しない場合,例外はスローされません。

(2) 形式

(a) 形式1
boolean removeObject()
(b) 形式2
boolean removeObject(
     boolean     isAlsoChildren
)
(c) 形式3

boolean removeObject(

     DbjReferencePathInfo      pathInfo
)

(3) 引数

isAlsoChildren(入力)
リンク先オブジェクトの削除を指定します。trueの場合,リンク先オブジェクトを削除します。falseの場合,リンク先オブジェクトを削除しません。
pathInfo(入力)
リファレンスファイル管理機能を使用したオブジェクトの削除時に使用する,パス情報を設定します。nullを指定すると例外がスローされます。

(4) 戻り値

次に示す値が返却されます。

true
リンク先オブジェクトが削除されました。
false
該当する文書管理オブジェクトが存在しませんでした。

(5) 例外

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