1.3.2 文書管理クラスのメソッド一覧

文書管理クラスの各インターフェースのメソッドの一覧を示します。

<この項の構成>
(1) DbjDocSpaceインターフェース(文書空間へのアクセスを扱うインターフェース)
(2) DbjLinkObjインターフェース(一つのリンクオブジェクトにアクセスするインターフェース)
(3) DbjLinkObjListインターフェース(DbjLinkObjインターフェースを要素とするリストインターフェースを扱うインターフェース)
(4) DbjObjインターフェース(一つの文書空間オブジェクトのアクセスを扱うインターフェース)
(5) DbjObjListインターフェース(複数の文書空間オブジェクトに一括してアクセスするためのインターフェース)
(6) DbjSessionインターフェース(Java クラスライブラリのセッションを管理するインターフェース)
(7) DbjVerObjインターフェース(一つの文書空間オブジェクトにアクセスするインターフェースに加え,バージョンオブジェクトのバージョン識別子を扱うインターフェース)
(8) DbjVerObjListインターフェース(DbjVerObjインターフェースを要素とするリストインターフェースを扱うインターフェース)
(9) DbjXmlTranslatorインターフェース(XML文書のプロパティマッピングを扱うインターフェース)

(1) DbjDocSpaceインターフェース(文書空間へのアクセスを扱うインターフェース)

DbjDocSpaceインターフェースのメソッド一覧を表1-24に示します。

表1-24 DbjDocSpaceインターフェースのメソッド一覧

メソッド機能
Proxyオブジェクトを生成するメソッド
createLinkObjList複数のリンクオブジェクトアクセスインターフェースの取得
createObjConnection文書空間オブジェクトアクセスインターフェースの取得
createObjList複数の文書空間オブジェクトアクセスインターフェースの取得
アクセス制御モードを取得するメソッド
isAccessControlModeアクセス制御モードの取得
オブジェクトを削除するメソッド
removeObjects検索条件を指定したオブジェクトの削除
検索を扱うメソッド
changeSearchACLMode検索実行時のアクセス制御モードの変更
executeSearch検索の実行
getSearchACLMode検索実行時のアクセス制御モードの取得
メタ情報を取得するメソッド
getMeta文書空間のメタ情報の取得
文書空間オブジェクトを生成するメソッド
createDocumentバージョンなし文書の作成
createFolderバージョンなしフォルダの作成
createIndependentData独立データの作成
createPublicACLパブリックACLの作成
createVrDocumentバージョン付き文書の作成
createVrFolderバージョン付きフォルダの作成

(2) DbjLinkObjインターフェース(一つのリンクオブジェクトにアクセスするインターフェース)

DbjLinkObjインターフェースのメソッド一覧を表1-25に示します。

表1-25 DbjLinkObjインターフェースのメソッド一覧

メソッド機能
構成管理型リンクを変更するメソッド
changeToVTFix構成管理型リンクの構成管理モードをFIXモードに変更
changeToVTFloat構成管理型リンクの構成管理モードをFLOATINGモードに変更
リンクProxyオブジェクトのプロパティを取得するメソッド
getLinkIdリンク識別子の取得
getLinkTypeリンク種別の取得
getOwnerObjリンク元オブジェクトの取得
getTargetObjリンク先オブジェクトの取得
リンクProxyオブジェクトのプロパティ値集合を取得または設定するメソッド
propSetリンクProxyオブジェクトのプロパティ値集合インターフェースの取得
setPropSetリンクProxyオブジェクトのプロパティ値集合の設定
リンクオブジェクトのプロパティを取得または設定するメソッド
readPropertiesリンクプロパティの取得
writePropertiesリンクプロパティ値の設定
リンクオブジェクトを削除するメソッド
removeObjectリンクオブジェクトの削除

(3) DbjLinkObjListインターフェース(DbjLinkObjインターフェースを要素とするリストインターフェースを扱うインターフェース)

DbjLinkObjListインターフェースのメソッド一覧を表1-26に示します。

表1-26 DbjLinkObjListインターフェースのメソッド一覧

メソッド機能
構成管理型リンクを一括して変更するメソッド
changeToVTFix構成管理型リンクの構成管理モードを一括してFIXモードに変更
changeToVTFloat構成管理型リンクの構成管理モードを一括してFLOATINGモードに変更
リンクProxyオブジェクトのプロパティを一括して取得するメソッド
getLinkIdListターゲットリンク識別子プロパティのリストの取得
getLinkObjリスト要素のDbjLinkObjインターフェースの取得
getOwnerObjListリンク元オブジェクトのリストの取得
getTargetObjListリンク先オブジェクトのリストの取得
リンクオブジェクトのプロパティを一括して取得または設定するメソッド
readPropertiesリンクプロパティ値の一括取得
writePropertiesリンクプロパティ値の一括設定
リンクオブジェクトを一括して削除するメソッド
removeObjectsリンクオブジェクトの一括削除

(4) DbjObjインターフェース(一つの文書空間オブジェクトのアクセスを扱うインターフェース)

DbjObjインターフェースのメソッド一覧を表1-27に示します。

表1-27 DbjObjインターフェースのメソッド一覧

メソッド機能
アクセス対象のターゲットバージョンを変更するメソッド
getTargetVersionアクセス対象ターゲットバージョンのバージョン識別子の取得
setTargetVersionアクセス対象ターゲットバージョンのバージョン識別子の変更
文書空間オブジェクトのプロパティを取得するメソッド
getClassNameアクセス対象文書空間オブジェクトを構成するDMAクラス名の取得
getLockTypeProxyオブジェクトのアクセスロック種別の取得
getObjTypeアクセス対象文書空間オブジェクトのオブジェクト種別の取得
getOiidアクセス対象文書空間オブジェクトのOIIDの取得
コンテンツにアクセスするメソッド
downloadContents文書のコンテンツのダウンロード
uploadContents文書のコンテンツのアップロード
バージョンを扱うメソッド
cancelCheckOutバージョン付きオブジェクトのチェックアウトの取り消し
checkInバージョン付きオブジェクトのチェックイン
checkOutバージョン付きオブジェクトのチェックアウト
deleteVersionバージョンの削除
getCheckOutStatusバージョン付きオブジェクトのチェックアウト状態の取得
getVersionIdバージョンオブジェクトのバージョン識別子の取得
getVersioningInfoバージョン付きオブジェクトのバージョニングオブジェクトの取得
getVersionObjListバージョン付きオブジェクトのバージョン一覧の取得
パブリックACLを扱うメソッド
bindPublicACLパブリックACLのバインド
getBindObjectListパブリックACLにバインドしている文書空間オブジェクト一覧の取得
getPublicACLListバインドしているパブリックACL一覧の取得
unbindPublicACLパブリックACLのアンバインド
プロパティ値集合を取得または設定するメソッド
propSetProxyオブジェクトのプロパティ値集合インターフェースの取得
setPropSetProxyオブジェクトのプロパティ値集合の設定
プロパティ値を取得または設定するメソッド
readProperties文書空間オブジェクトのプロパティ値の読み込み
writeProperties文書空間オブジェクトのプロパティ値の設定
文書空間オブジェクトを削除するメソッド
removeObject文書空間オブジェクトの削除
リンクをたどって文書空間オブジェクトを取得するメソッド
getChildListフォルダのリンク先オブジェクト(下位オブジェクト)の取得
getDCRParent直接型リンクによるリンク元オブジェクトの取得
getParentListフォルダのリンク元オブジェクトの取得
getRelList文書間リンク一覧の取得
リンクおよびリンクを解除するメソッド
changeToVTFix構成管理型リンクの構成管理モードをFIXモードに変更
changeToVTFloat構成管理型リンクの構成管理モードをFLOATINGモードに変更
linkリンク先オブジェクトとのリンク
move直接型リンクが設定されている文書空間オブジェクトの移動
unlinkリンク先オブジェクトとのリンクの解除
unlinkByLinkIdリンク識別子の指定によるリンク先オブジェクトとのリンクの解除
レンディションを扱うメソッド
addRenditionレンディションの追加
changeMasterRenditionマスタレンディションの変更
deleteRenditionレンディションの削除
getRenditionListレンディション情報一覧の取得
writeRenditionPropertiesレンディションプロパティの設定
アクセスロックが異なる文書空間オブジェクトインターフェースを取得するメソッド
lockアクセスロック種別の異なる文書空間オブジェクトインターフェースの取得

(5) DbjObjListインターフェース(複数の文書空間オブジェクトに一括してアクセスするためのインターフェース)

DbjObjListインターフェースのメソッド一覧を表1-28に示します。

表1-28 DbjObjListインターフェースのメソッド一覧

メソッド機能
オブジェクトを一括して移動するメソッド
move直接型リンクが設定されている文書空間オブジェクトの一括移動
プロパティ値集合を一括して設定するメソッド
setPropSet要素のプロパティ値集合の設定
プロパティ値を一括して取得または設定するメソッド
readProperties複数の文書空間オブジェクトプロパティ値の一括取得
writeProperties複数の文書空間オブジェクトプロパティ値の一括設定
文書空間オブジェクトを一括して削除するメソッド
removeObjects文書空間オブジェクトの一括削除
要素を一括して取得するメソッド
getObjリスト要素の取得
ロックを一括して指定するメソッド
lockアクセスロック種別の異なる複数文書空間オブジェクトインターフェースの取得

(6) DbjSessionインターフェース(Java クラスライブラリのセッションを管理するインターフェース)

DbjSessionインターフェースのメソッド一覧を表1-29に示します。

表1-29 DbjSessionインターフェースのメソッド一覧

メソッド機能
セッションを扱うメソッド
checkSessionセッションが有効かどうかのチェック
getLoginUserInfoユーザ情報の取得
loginログイン
logoutログアウト
トランザクションを扱うメソッド
beginトランザクションの開始
commitトランザクションの確定
rollbackトランザクションの取り消し
コンテンツ格納先ベースパスを扱うメソッド
getReferencePathコンテンツ格納先ベースパスの取得
setReferencePathコンテンツ格納先ベースパスの設定

(7) DbjVerObjインターフェース(一つの文書空間オブジェクトにアクセスするインターフェースに加え,バージョンオブジェクトのバージョン識別子を扱うインターフェース)

DbjVerObjインターフェースのメソッド一覧を表1-30に示します。

表1-30 DbjVerObjインターフェースのメソッド一覧

メソッド機能
バージョンオブジェクトのバージョン識別子を取得するメソッド
getVersionIdバージョンオブジェクトのバージョン識別子の取得

(8) DbjVerObjListインターフェース(DbjVerObjインターフェースを要素とするリストインターフェースを扱うインターフェース)

DbjVerObjListインターフェースのメソッド一覧を表1-31に示します。

表1-31 DbjVerObjListインターフェースのメソッド一覧

メソッド機能
要素のバージョンオブジェクトのバージョン識別子を一括して取得するメソッド
getVerObj要素のDbjVerObjインターフェースの取得
getVersionIdListオブジェクトのバージョン識別子リストの取得

(9) DbjXmlTranslatorインターフェース(XML文書のプロパティマッピングを扱うインターフェース)

DbjXmlTranslatorインターフェースのメソッド一覧を表1-32に示します。

表1-32 DbjXmlTranslatorインターフェースのメソッド一覧

メソッド機能
getMappedPropertiesXML文書のXMLプロパティマッピング結果情報の作成