4.1.9 createVrDocumentバージョン付き文書の作成

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

(1) 機能

文書空間にバージョン付き文書を作成し,指定したリンク元フォルダにリンクを設定します。作成したバージョン付き文書の文書空間オブジェクトアクセスインターフェース(DbjObjインターフェース)を取得します。バージョン付き文書を作成する場合にバージョン付き文書を構成するクラス名,およびバージョン付き文書のプロパティの初期値を指定できます。また,リファレンスファイル管理機能を使用したバージョン付き文書オブジェクトを作成する場合は,引数uploadListにDbjReferenceUploadInfoインターフェースを指定します。

dbrProp_RetrievalName(レンディションに登録されたコンテンツのファイル名)プロパティを指定する方法と指定の優先順位を次に示します。

表4-2 dbrProp_RetrievalNameプロパティの指定方法と優先順位

dbrProp_RetrievalNameプロパティの指定方法優先順位
引数uploadListが持つ要素のretrievalNameプロパティに指定1
引数uploadListが持つ要素のrenditionPropSetプロパティのdbrProp_RetrievalNameに指定2
引数propSetにバージョニングオブジェクトのプロパティとしてdbrProp_RetrievalNameを指定(マスタレンディションだけ)3
引数propSetにバージョンオブジェクトのプロパティとしてdbrProp_RetrievalNameを指定(マスタレンディションだけ)4

上記のいずれも指定しなかった場合,引数uploadListの要素が持つfilePathプロパティに含まれるファイル名を設定します。また,リファレンスファイル管理機能を使用している場合は,entryプロパティに含まれるファイル名を設定します。

(2) 形式

DbjObj createVrDocument(
    String         classNameVersioning,
    String         classNameVersion,
    DbjPropSet     propSet,
    List           uploadList,
    List           parentLinkList
)

(3) 引数

classNameVersioning(入力)
作成するバージョン付き文書のバージョニングオブジェクトのクラス名を指定します。dmaClass_ConfigurationHistoryクラス,またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるdmaClass_ConfigurationHistoryクラスが仮定されます。
classNameVersion(入力)
作成するバージョン付き文書のバージョンオブジェクトのクラス名を指定します。dmaClass_DocVersionクラス,またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるedmClass_VersionTracedDocVersionクラスが仮定されます。
propSet(入力)
作成するバージョン付き文書のプロパティの初期値として設定するプロパティ値集合を指定します。バージョニングオブジェクトとバージョンオブジェクト(カレントバージョン)のプロパティを同時に設定できます。プロパティの初期値を指定しない場合はnullを指定します。
uploadList(入力)
要素は,DbjUploadInfoインターフェースまたはそのサブインターフェースです。作成するバージョン付き文書に登録するファイル情報(アップロード情報)のリストを指定します。複数の要素を指定するとマルチレンディションになります。アップロードするファイルを指定しない場合はnullを指定します。
parentLinkList(入力)
要素は,DbjSetLinkInfoインターフェースのサブインターフェースです。作成するバージョン付き文書にリンクを設定するリンク元フォルダオブジェクト群とリンク種別のリストを指定します。フォルダにリンクを設定しない場合はnullを指定します。

(4) 戻り値

作成したバージョン付き文書の文書空間オブジェクトアクセスインターフェース(DbjObjインターフェース)

(5) 例外

ClassCastException
引数parentLinkListの要素がDbjSetLinkInfoインターフェースでなかった場合
DbjAccessControlException
アクセス権エラーの場合
DbjACEOperationException
指定ACEについてのエラーの場合
DbjCORBAException
CORBAエラーの場合
DbjDBException
DBエラーの場合
DbjException
Java クラスライブラリ固有のエラーの場合
DbjFileReferenceOperationFailedException
リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合
DbjIllegalObjectTypeException
指定オブジェクト種別が不適切の場合
DbjIllegalPropValException
指定プロパティ値が不正の場合
DbjIOException
Java クラスライブラリ固有のIOエラーの場合
DbjMasterRenditionNotSetException
マスタレンディションのレンディションタイプが設定されていなかった場合
DbjObjectNotFoundException
指定オブジェクトが存在しなかった場合
DbjPublicACLNotFoundException
指定パブリックACLが存在しなかった場合
DbjPublicACLOutOfRangeException
指定パブリックACL数が範囲を超えた場合
DbjRenditionCountOutOfRangeException
指定レンディション数が範囲を超えた場合
DbjRenditionTypeDuplicatedException
指定レンディションタイプが重複していた場合
DbjSessionNotConnectException
セッションが接続されていなかった場合
DbjTargetContentPathNotSetException
リファレンスファイル管理機能で,コンテンツ格納先ベースパスが設定されていなかった場合
DbjXmlParseException
XML文書解析エラーの場合
IllegalArgumentException
引数の指定が不正の場合
NullPointerException
値が必要な引数がnullの場合