ここでは,文書空間オブジェクトを操作するインターフェースの機能について説明します。
特定の文書空間オブジェクトを操作する場合に使用するインターフェースについて説明します。Java クラスライブラリでは,文書空間オブジェクトを,種類に関係なく同じインターフェースを使用して操作します。例えば,文書空間オブジェクトのプロパティを操作する場合は,操作する対象が文書やフォルダなど,どの文書空間オブジェクトであっても,同じDbjObjインターフェースなどのメソッドを使用します。ただし,操作する文書空間オブジェクトの種類によって,実行できるメソッドは異なります。例えば,フォルダを操作するためのDbjObjインターフェースを取得している場合に,文書のコンテンツを更新するDbjObj#uploadContentsメソッドを実行することはできません。詳細は,「(3) メソッドとオブジェクト種別の対応」を参照してください。
文書空間オブジェクトを操作するために使用するインターフェースの種類を次に示します。また,インターフェースを取得するメソッドの例を示します。
なお,DbjObjListインターフェース,DbjVerObjListインターフェースおよびDbjLinkObjListインターフェースは,java.util.Listインターフェースを継承しています。
ここでは,文書空間オブジェクトを操作するインターフェースで実行できる操作について説明します。
文書空間オブジェクトを操作するインターフェースで実行できる操作を,次の表に示します。それぞれの操作の詳細については,参照先の説明を参照してください。
表6-5 文書空間オブジェクトを操作するインターフェースで実行できる操作
実行できる操作の種類 | 説 明 | 参照先 |
---|---|---|
文書空間オブジェクトの情報を取得する | OIIDやオブジェクト種別,文書空間オブジェクトを構成するDMAクラスの情報を取得します。 | 6.8.5 |
文書空間オブジェクトへのアクセス方法を変更する | バージョン付きオブジェクトの操作対象のバージョンを変更したり,文書空間オブジェクトに設定するロック種別を変更したりします。 | 6.8.6 |
文書空間オブジェクトのプロパティを操作する | 文書空間オブジェクトに設定したプロパティを参照したり,更新したりします。 | 6.8.7 |
文書空間オブジェクトを削除する | 文書空間オブジェクトを削除します。 | 6.8.8 |
文書のコンテンツを操作する | 文書のコンテンツをダウンロードしたり,アップロードしたりします。 | 6.8.9 |
バージョン付きオブジェクトのバージョンを操作する | バージョン付きオブジェクトをバージョンアップしたり,バージョン一覧を取得したり,バージョンを削除したりします。 | 6.8.10 |
マルチレンディション文書を操作する | マルチレンディション文書を作成したり,レンディションを追加したり,レンディションにプロパティを設定したりします。 | 6.8.11 |
リファレンスファイル文書を操作する | リファレンスファイル文書を作成したり,削除したりします。また,リファレンスファイル文書のコンテンツをアップロードしたり,ダウンロードしたりします。 | 6.8.12 |
文書空間オブジェクトを関連付けて管理する | 文書空間オブジェクトを関連付けるために,リンクオブジェクトを使用して管理します。また,リンクをたどって文書空間オブジェクトを取得します。 | 6.8.13 |
複数の文書空間オブジェクトを一括して操作する | 複数の文書空間オブジェクトのプロパティやコンテンツを一括して参照したり,複数の文書空間オブジェクトを一括して移動したり,削除したりします。 | 6.8.14 |
アクセス制御機能を使用する | ローカルACLの値を設定したり,パブリックACLを作成して文書空間オブジェクトからバインドしたりします。 | 6.9 |
XML文書管理機能を使用する | DbjXmlUploadInfoインターフェースおよびDbjXmlTranslatorインターフェースを使用してXML文書管理機能を使用します。 | 6.10 |
DbjObjインターフェースおよびDbjVerObjインターフェースのメソッドと,実行できる文書空間オブジェクトのオブジェクト種別の対応を次の表に示します。それぞれのメソッドの詳細は,マニュアル「DocumentBroker Version 3 クラスライブラリ Java リファレンス」の各メソッドの説明を参照してください。
表6-6 メソッドを実行できる文書空間オブジェクトのオブジェクト種別
メソッド | D | VD | F | VF | IP | PA |
---|---|---|---|---|---|---|
DbjObjインターフェース | ||||||
addRendition | ○ | ○ | × | × | × | × |
bindPublicACL | ○ | ○ | ○ | ○ | ○ | × |
cancelCheckOut | × | ○ | × | ○ | × | × |
changeMasterRendition | ○ | ○ | × | × | × | × |
changeToVTFix | × | × | × | ○ | × | × |
changeToVTFloat | × | × | × | ○ | × | × |
checkIn | × | ○ | × | ○ | × | × |
checkOut | × | ○ | × | ○ | × | × |
deleteRendition | ○ | ○ | × | × | × | × |
deleteVersion | × | ○ | × | ○ | × | × |
downloadContents | ○ | ○ | × | × | × | × |
getBindObjectList | × | × | × | × | × | ○ |
getCheckOutStatus | × | ○ | × | ○ | × | × |
getChildList | × | × | ○ | ○ | × | × |
getClassName | ○ | ○ | ○ | ○ | ○ | ○ |
getDCRParent | ○ | ○ | ○ | ○ | × | × |
getLockType | ○ | ○ | ○ | ○ | ○ | ○ |
getObjType | ○ | ○ | ○ | ○ | ○ | ○ |
getOiid | ○ | ○ | ○ | ○ | ○ | ○ |
getParentList | ○ | ○ | ○ | ○ | × | × |
getPublicACLList | ○ | ○ | ○ | ○ | ○ | × |
getRelList | ○ | ○ | × | × | × | × |
getRenditionList | ○ | ○ | × | × | × | × |
getTargetVersion | × | ○ | × | ○ | × | × |
getVersionId | ○※ | ○※ | ○※ | ○※ | ○※ | ○※ |
getVersioningInfo | ○※ | ○※ | ○※ | ○※ | ○※ | ○※ |
getVersionObjList | × | ○ | × | ○ | × | × |
link | ○ | ○ | ○ | ○ | × | × |
lock | ○ | ○ | ○ | ○ | ○ | ○ |
move | ○ | ○ | ○ | ○ | × | × |
propSet | ○ | ○ | ○ | ○ | ○ | ○ |
readProperties | ○ | ○ | ○ | ○ | ○ | ○ |
removeObject | ○ | ○ | ○ | ○ | ○ | ○ |
setPropSet | ○ | ○ | ○ | ○ | ○ | ○ |
setTargetVersion | × | ○ | × | ○ | × | × |
unbindPublicACL | ○ | ○ | ○ | ○ | ○ | × |
unlink | ○ | ○ | ○ | ○ | × | × |
unlinkByLinkId | ○ | ○ | ○ | ○ | × | × |
uploadContents | ○ | ○ | × | × | × | × |
writeProperties | ○ | ○ | ○ | ○ | ○ | ○ |
writeRenditionProperties | ○ | ○ | × | × | × | × |
DbjVerObjインターフェース | ||||||
getVersionId | ○※ | ○※ | ○※ | ○※ | ○※ | ○※ |
(凡例)
D:バージョンなし文書またはバージョン付き文書のバージョンオブジェクト
VD:バージョン付き文書
F:バージョンなしフォルダまたはバージョン付きフォルダのバージョンオブジェクト
VF:バージョン付きフォルダ
IP:独立データ
PA:パブリックACL
○:実行できます。
×:実行できません。または実行しても無効です。
注※ バージョン付きオブジェクトのバージョンオブジェクト以外で実行した場合は,nullが返却されます。
なお,DbjObjListインターフェースおよびDbjVerObjListインターフェースで実行できるメソッドは,それぞれの要素であるDbjObjインターフェースおよびDbjVerObjインターフェースが対応する文書空間オブジェクトで実行できるメソッドです。