uCosminexus DocumentBroker Version 5 リファレンス API

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

6.4.22 getRenditionListレンディション情報一覧の取得

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

(1) 機能

Proxyオブジェクトのアクセス対象の文書が保持するレンディション情報の一覧をすべて取得します。レンディション情報を取得できるアクセス対象の文書管理オブジェクトは,文書だけです。

(2) 形式

DbjRenditionList getRenditionList(
     Collection<String>     propDefs
)

(3) 引数

propDefs(入力)
要素はレンディションプロパティ名(String型)です。一覧で取得するレンディションのプロパティ名のコレクションを指定します。取得するレンディションプロパティがない場合はnullを指定します。次に示すプロパティを指定できます。
  • dbrProp_RetrievalNameプロパティ
  • dbrProp_RenditionStatusプロパティ
  • dbrProp_ContentTypeプロパティ
  • dbrProp_ContentLocationプロパティ
  • dbrProp_ReferenceTypeプロパティ

(4) 戻り値

レンディション一覧情報(DbjRenditionListインターフェース)

(5) 例外

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