uCosminexus DocumentBroker Version 5 リファレンス API
ここでは,文書管理オブジェクトを操作するインターフェースの機能について説明します。
特定の文書管理オブジェクトを操作する場合に使用するインターフェースについて説明します。DocumentBrokerクラスライブラリでは,文書管理オブジェクトを,種類に関係なく同じインターフェースを使用して操作します。例えば,文書管理オブジェクトのプロパティを操作する場合は,操作する対象が文書やフォルダなど,どの文書管理オブジェクトであっても,同じDbjObjインターフェースなどのメソッドを使用します。ただし,操作する文書管理オブジェクトの種類によって,実行できるメソッドは異なります。例えば,フォルダを操作するためのDbjObjインターフェースを取得している場合に,文書のコンテンツを更新するDbjObj#uploadContentsメソッドを実行することはできません。詳細は,「(3) メソッドとオブジェクト種別の対応」を参照してください。
文書管理オブジェクトを操作するために使用するインターフェースの種類を次に示します。また,インターフェースを取得するメソッドの例を示します。
なお,DbjObjListインターフェース,DbjVerObjListインターフェースおよびDbjLinkObjListインターフェースは,java.util.Listインターフェースを継承しています。
ここでは,文書管理オブジェクトを操作するインターフェースで実行できる操作について説明します。
文書管理オブジェクトを操作するインターフェースで実行できる操作を,次の表に示します。それぞれの操作の詳細については,参照先の説明を参照してください。
表1-6 文書管理オブジェクトを操作するインターフェースで実行できる操作
| 実行できる操作の種類 | 説 明 | 参照先 |
|---|---|---|
| 文書管理オブジェクトの情報を取得する | OIIDやオブジェクト種別,文書管理オブジェクトを構成するDocumentBrokerクラスの情報を取得します。 | 1.10.5 |
| 文書管理オブジェクトへのアクセス方法を変更する | バージョン付きオブジェクトの操作対象のバージョンを変更したり,文書管理オブジェクトに設定するロック種別を変更したりします。 | 1.10.6 |
| 文書管理オブジェクトのプロパティを操作する | 文書管理オブジェクトに設定したプロパティを参照したり,更新したりします。 | 1.10.7 |
| 文書管理オブジェクトを削除する | 文書管理オブジェクトを削除します。 | 1.10.8 |
| 文書のコンテンツを操作する | 文書のコンテンツをダウンロードしたり,アップロードしたりします。 | 1.10.9 |
| バージョン付きオブジェクトのバージョンを操作する | バージョン付きオブジェクトをバージョンアップしたり,バージョン一覧を取得したり,バージョンを削除したりします。 | 1.10.10 |
| マルチレンディション文書を操作する | マルチレンディション文書を作成したり,レンディションを追加したり,レンディションにプロパティを設定したりします。 | 1.10.11 |
| リファレンスファイル文書を操作する | リファレンスファイル文書を作成したり,削除したりします。また,リファレンスファイル文書のコンテンツをアップロードしたり,ダウンロードしたりします。 | 1.10.12 |
| 文書管理オブジェクトを関連付けて管理する | 文書管理オブジェクトを関連付けるために,リンクオブジェクトを使用して管理します。また,リンクをたどって文書管理オブジェクトを取得します。 | 1.10.13 |
| 複数の文書管理オブジェクトを一括して操作する | 複数の文書管理オブジェクトのプロパティやコンテンツを一括して参照したり,複数の文書管理オブジェクトを一括して移動したり,削除したりします。 | 1.10.14 |
| アクセス制御機能を使用する | ローカルACLの値を設定したり,パブリックACLを作成して文書管理オブジェクトからバインドしたりします。 | 1.11 |
DbjObjインターフェースおよびDbjVerObjインターフェースのメソッドと,実行できる文書管理オブジェクトのオブジェクト種別の対応を次の表に示します。それぞれのメソッドについては,各メソッドの説明を参照してください。
表1-7 メソッドを実行できる文書管理オブジェクトのオブジェクト種別
| メソッド | D | VD | F | IP | PA |
|---|---|---|---|---|---|
| DbjObjインターフェース | |||||
| addRendition | ○ | ○ | × | × | × |
| bindPublicACL | ○ | ○ | ○ | ○ | × |
| cancelCheckOut | × | ○ | × | × | × |
| changeMasterRendition | ○ | ○ | × | × | × |
| checkIn | × | ○ | × | × | × |
| checkOut | × | ○ | × | × | × |
| convertContentIType | ○ | ○ | × | × | × |
| 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 | ○※ | ○※ | ○※ | ○※ | ○※ |
なお,DbjObjListインターフェースおよびDbjVerObjListインターフェースで実行できるメソッドは,それぞれの要素であるDbjObjインターフェースおよびDbjVerObjインターフェースが対応する文書管理オブジェクトで実行できるメソッドです。
All Rights Reserved. Copyright (C) 2012, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2012, 2013, Hitachi Solutions, Ltd.