![[目次]](FIGURE/CONTENT.GIF)
uCosminexus DocumentBroker Version 5 リファレンス API
![[用語]](FIGURE/GLOSS.GIF)
![[索引]](FIGURE/INDEX.GIF)
![[前へ]](FIGURE/FRONT.GIF)
![[次へ]](FIGURE/AFTER.GIF)
文書管理クラスの各インターフェースのメソッドの一覧を示します。
DbjDocSpaceインターフェースのメソッド一覧を次の表に示します。
表3-23 DbjDocSpaceインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| Proxyオブジェクトを生成するメソッド | |
| createLinkObjList | 複数のリンクオブジェクトアクセスインターフェースの取得 |
| createObjConnection | 文書管理オブジェクトアクセスインターフェースの取得 |
| createObjList | 複数の文書管理オブジェクトアクセスインターフェースの取得 |
| アクセス制御モードを取得するメソッド | |
| isAccessControlMode | アクセス制御モードの取得 |
| オブジェクトを削除するメソッド | |
| removeObjects | 検索条件を指定したオブジェクトの削除 |
| 検索を扱うメソッド | |
| changeSearchACLMode | 検索実行時のアクセス制御モードの変更 |
| executeSearch | 検索の実行 |
| getSearchACLMode | 検索実行時のアクセス制御モードの取得 |
| メタ情報を取得するメソッド | |
| getMeta | 文書空間のメタ情報の取得 |
| 文書管理オブジェクトを生成するメソッド | |
| createDocument | バージョンなし文書の作成 |
| createFolder | バージョンなしフォルダの作成 |
| createIndependentData | 独立データの作成 |
| createPublicACL | パブリックACLの作成 |
| createVrDocument | バージョン付き文書の作成 |
DbjLinkObjインターフェースのメソッド一覧を次の表に示します。
表3-24 DbjLinkObjインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| リンクProxyオブジェクトのプロパティを取得するメソッド | |
| getLinkId | リンク識別子の取得 |
| getLinkType | リンク種別の取得 |
| getOwnerObj | リンク元オブジェクトの取得 |
| getTargetObj | リンク先オブジェクトの取得 |
| リンクProxyオブジェクトのプロパティ値集合を取得または設定するメソッド | |
| propSet | リンクProxyオブジェクトのプロパティ値集合インターフェースの取得 |
| setPropSet | リンクProxyオブジェクトのプロパティ値集合の設定 |
| リンクオブジェクトのプロパティを取得または設定するメソッド | |
| readProperties | リンクプロパティの取得 |
| writeProperties | リンクプロパティ値の設定 |
| リンクオブジェクトを削除するメソッド | |
| removeObject | リンクオブジェクトの削除 |
DbjLinkObjListインターフェースのメソッド一覧を次の表に示します。
表3-25 DbjLinkObjListインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| リンクProxyオブジェクトのプロパティを一括して取得するメソッド | |
| getLinkIdList | ターゲットリンク識別子プロパティのリストの取得 |
| getLinkObj | リスト要素のDbjLinkObjインターフェースの取得 |
| getOwnerObjList | リンク元オブジェクトのリストの取得 |
| getTargetObjList | リンク先オブジェクトのリストの取得 |
| リンクオブジェクトのプロパティを一括して取得または設定するメソッド | |
| readProperties | リンクプロパティ値の一括取得 |
| writeProperties | リンクプロパティ値の一括設定 |
| リンクオブジェクトを一括して削除するメソッド | |
| removeObjects | リンクオブジェクトの一括削除 |
DbjObjインターフェースのメソッド一覧を次の表に示します。
| メソッド | 機能 |
|---|---|
| アクセス対象のターゲットバージョンを変更するメソッド | |
| getTargetVersion | アクセス対象ターゲットバージョンのバージョン識別子の取得 |
| setTargetVersion | アクセス対象ターゲットバージョンのバージョン識別子の変更 |
| 文書管理オブジェクトのプロパティを取得するメソッド | |
| getClassName | アクセス対象文書管理オブジェクトを構成するDocumentBrokerクラス名の取得 |
| 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 | 文書間リンク一覧の取得 |
| リンクおよびリンクを解除するメソッド | |
| link | リンク先オブジェクトとのリンク |
| move | 直接型リンクが設定されている文書管理オブジェクトの移動 |
| unlink | リンク先オブジェクトとのリンクの解除 |
| unlinkByLinkId | リンク識別子の指定によるリンク先オブジェクトとのリンクの解除 |
| レンディションを扱うメソッド | |
| addRendition | レンディションの追加 |
| changeMasterRendition | マスタレンディションの変更 |
| deleteRendition | レンディションの削除 |
| getRenditionList | レンディション情報一覧の取得 |
| writeRenditionProperties | レンディションプロパティの設定 |
| コンテンツ種別を変更するメソッド | |
| convertContentType | コンテンツ種別の変換 |
| アクセスロックが異なる文書管理オブジェクトインターフェースを取得するメソッド | |
| lock | アクセスロック種別の異なる文書管理オブジェクトインターフェースの取得 |
DbjObjListインターフェースのメソッド一覧を次の表に示します。
表3-27 DbjObjListインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| オブジェクトを一括して移動するメソッド | |
| move | 直接型リンクが設定されている文書管理オブジェクトの一括移動 |
| プロパティ値集合を一括して設定するメソッド | |
| setPropSet | 要素のプロパティ値集合の設定 |
| プロパティ値を一括して取得または設定するメソッド | |
| readProperties | 複数の文書管理オブジェクトプロパティ値の一括取得 |
| writeProperties | 複数の文書管理オブジェクトプロパティ値の一括設定 |
| 文書管理オブジェクトを一括して削除するメソッド | |
| removeObjects | 文書管理オブジェクトの一括削除 |
| 要素を一括して取得するメソッド | |
| getObj | リスト要素の取得 |
| ロックを一括して指定するメソッド | |
| lock | アクセスロック種別の異なる複数文書管理オブジェクトインターフェースの取得 |
DbjSessionインターフェースのメソッド一覧を次の表に示します。
表3-28 DbjSessionインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| セッションを扱うメソッド | |
| checkSession | セッションが有効かどうかのチェック |
| getLoginUserInfo | ユーザ情報の取得 |
| login | ログイン |
| logout | ログアウト |
| トランザクションを扱うメソッド | |
| begin | トランザクションの開始 |
| commit | トランザクションの確定 |
| rollback | トランザクションの取り消し |
| コンテンツ格納先ベースパスを扱うメソッド | |
| getReferencePath | コンテンツ格納先ベースパスの取得 |
| setReferencePath | コンテンツ格納先ベースパスの設定 |
DbjVerObjインターフェースのメソッド一覧を次の表に示します。
表3-29 DbjVerObjインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| バージョンオブジェクトのバージョン識別子を取得するメソッド | |
| getVersionId | バージョンオブジェクトのバージョン識別子の取得 |
DbjVerObjListインターフェースのメソッド一覧を次の表に示します。
表3-30 DbjVerObjListインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| 要素のバージョンオブジェクトのバージョン識別子を一括して取得するメソッド | |
| getVerObj | 要素のDbjVerObjインターフェースの取得 |
| getVersionIdList | オブジェクトのバージョン識別子リストの取得 |
All Rights Reserved. Copyright (C) 2012, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2012, 2013, Hitachi Solutions, Ltd.