uCosminexus DocumentBroker Version 3 クラスライブラリ Java リファレンス

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

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クラス名の取得
getLockType Proxyオブジェクトのアクセスロック種別の取得
getObjType アクセス対象文書空間オブジェクトのオブジェクト種別の取得
getOiid アクセス対象文書空間オブジェクトのOIIDの取得
コンテンツにアクセスするメソッド
downloadContents 文書のコンテンツのダウンロード
uploadContents 文書のコンテンツのアップロード
バージョンを扱うメソッド
cancelCheckOut バージョン付きオブジェクトのチェックアウトの取り消し
checkIn バージョン付きオブジェクトのチェックイン
checkOut バージョン付きオブジェクトのチェックアウト
deleteVersion バージョンの削除
getCheckOutStatus バージョン付きオブジェクトのチェックアウト状態の取得
getVersionId バージョンオブジェクトのバージョン識別子の取得
getVersioningInfo バージョン付きオブジェクトのバージョニングオブジェクトの取得
getVersionObjList バージョン付きオブジェクトのバージョン一覧の取得
パブリックACLを扱うメソッド
bindPublicACL パブリックACLのバインド
getBindObjectList パブリックACLにバインドしている文書空間オブジェクト一覧の取得
getPublicACLList バインドしているパブリックACL一覧の取得
unbindPublicACL パブリックACLのアンバインド
プロパティ値集合を取得または設定するメソッド
propSet Proxyオブジェクトのプロパティ値集合インターフェースの取得
setPropSet Proxyオブジェクトのプロパティ値集合の設定
プロパティ値を取得または設定するメソッド
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インターフェースのメソッド一覧

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