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

文法書

3000-3-F17-20

目　　次

前書き

変更内容

はじめに

1.　Java クラスライブラリのクラス，インターフェース，およびメソッド

1.1　ファクトリクラスのインターフェース，およびメソッド一覧

1.1.1　ファクトリクラスのクラスおよびインターフェース

1.1.2　ファクトリクラスのメソッド一覧

1.2　パラメタクラスのインターフェース，およびメソッド一覧

1.2.1　パラメタクラスのインターフェース一覧

1.2.2　パラメタクラスのメソッド一覧

1.3　文書管理クラスのインターフェース，およびメソッド一覧

1.3.1　文書管理クラスのインターフェース一覧

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

1.4　メタクラスのインターフェース，およびメソッド一覧

1.4.1　メタクラスのインターフェース一覧

1.4.2　メタクラスのメソッド一覧

1.5　例外クラスのクラス一覧，スーパークラス，およびコンストラクタ

1.5.1　例外クラスのクラス一覧

1.5.2　例外クラスのスーパークラス

1.5.3　例外クラスのコンストラクタ

1.6　定数定義クラスのカテゴリ一覧

1.7　ライブラリ情報取得クラスのクラス，およびメソッド一覧

1.7.1　ライブラリ情報取得クラスのクラス

1.7.2　ライブラリ情報取得クラスのメソッド一覧

1.8　トレースクラスのクラス，およびメソッド一覧

1.8.1　トレースクラスのクラス

1.8.2　トレースクラスのメソッド一覧

1.9　クラス，インターフェースおよびメソッドの説明形式

1.9.1　メソッドで説明する項目

1.9.2　パラメタクラスのインターフェースで説明する項目

1.9.3　文書空間オブジェクトのプロパティのデータ型

2.　ファクトリクラス詳細

2.1　DbjFactory0200クラス

2.1.1　getFactory（ファクトリインターフェースの取得）

2.1.2　getMetaManager（メタマネージャーインターフェースの取得）

2.2　DbjFactoryインターフェース

2.2.1　createACE（ACEの作成）

2.2.2　createBooleanQParam（BOOL型の?パラメタの作成）

2.2.3　createFetchInfo（検索結果取得情報オブジェクトの作成）

2.2.4　createInteger32QParam（INT型の?パラメタの作成）

2.2.5　createOIIDQParam（OIIDの?パラメタの作成）

2.2.6　createObjQParam（Object型の?パラメタの作成）

2.2.7　createPropSet（プロパティ値集合オブジェクトの作成）

2.2.8　createPublicACLIdElm（パブリックACLのOIIDエレメントの作成）

2.2.9　createReferencePathInfo（リファレンスファイル文書のパス情報オブジェクトの作成）

2.2.10　createReferenceUploadInfo（リファレンスファイル文書のアップロード情報オブジェクトの作成）

2.2.11　createSeedDocQParam（種文章の?パラメタの作成）

2.2.12　createSession（Java クラスライブラリのセッションオブジェクトの作成）

2.2.13　createSetDCRLinkInfo（直接型リンク設定情報の作成）

2.2.14　createSetRCRLinkInfo（参照型リンク設定情報の作成）

2.2.15　createSetRelLinkInfo（文書間リンク設定情報の作成）

2.2.16　createSetVTFixLinkInfo（構成管理モードがFIXモードの構成管理型リンク設定情報の作成）

2.2.17　createSetVTFloatLinkInfo（構成管理モードがFLOATINGモードの構成管理型リンク設定情報の作成）

2.2.18　createStringQParam（String型の?パラメタの作成）

2.2.19　createUploadInfo（文書のアップロード情報オブジェクトの作成）

2.2.20　createVArray（可変長配列オブジェクトの作成）

2.2.21　createXmlTranslator（XMLトランスレーターの取得）

2.2.22　createXmlUploadInfo（XML文書のアップロード情報オブジェクトの作成）

3.　パラメタクラス詳細

3.1　DbjACEインターフェース

3.1.1　getPermission（パーミッションの取得）

3.1.2　getSubject（サブジェクトの取得）

3.1.3　getSubjectType（サブジェクト種別の取得）

3.1.4　propSet（ACEのプロパティ値集合の取得）

3.1.5　setGroupSubject（サブジェクトをグループサブジェクトとして設定）

3.1.6　setPermission（パーミッションの設定）

3.1.7　setPropSet（ACEのプロパティ値集合の設定）

3.1.8　setSubject（サブジェクトの設定）

3.1.9　setSubjectType（サブジェクト種別の設定）

3.1.10　setSystemSubject（サブジェクトをシステムサブジェクトとして設定）

3.1.11　setUserSubject（サブジェクトをユーザサブジェクトとして設定）

3.2　DbjBooleanQParamインターフェース

3.3　DbjCheckOutInfoインターフェース

3.3.1　getCheckOutUserId（チェックアウトしたユーザのユーザ識別子の取得）

3.3.2　getCheckOutVersionId（仮のバージョン識別子の取得）

3.3.3　isCheckOut（チェックアウト中かどうかの判定）

3.4　DbjContentInfoインターフェース

3.4.1　getRenditionType（コンテンツのレンディションタイプの取得）

3.4.2　getRetrievalName（コンテンツのファイル名の取得）

3.5　DbjFetchInfoインターフェース

3.5.1　getCacheKey（キャッシュキーの取得）

3.5.2　getCacheName（キャッシュ名の取得）

3.5.3　getCacheTotal（検索結果キャッシュの全件数の取得）

3.5.4　getComparator（Comparatorインターフェースの取得）

3.5.5　getFetchCount（検索結果の取得件数の取得）

3.5.6　getMaxFetchCount（検索結果の最大取得件数の取得）

3.5.7　getStartIndex（検索結果の取得開始位置の取得）

3.5.8　setCacheKey（キャッシュキーの設定）

3.5.9　setCacheName（キャッシュ名の設定）

3.5.10　setCacheTotal（検索結果キャッシュの全件数の設定）

3.5.11　setComparator（Comparatorインターフェースの設定）

3.5.12　setFetchCount（検索結果の取得件数の設定）

3.5.13　setMaxFetchCount（検索結果の最大取得件数の設定）

3.5.14　setStartIndex（検索結果の取得開始位置の設定）

3.6　DbjInteger32QParamインターフェース

3.7　DbjMappedPropインターフェース

3.7.1　getClassList（マッピングされたDMAクラス名のリストの取得）

3.7.2　propSet（マッピングされたプロパティ値集合の取得）

3.8　DbjObjQParamインターフェース

3.9　DbjOIIDQParamインターフェース

3.10　DbjPropSetインターフェース

3.10.1　changePropName（プロパティ名の変更）

3.10.2　changePropNames（プロパティ名の一括変更）

3.10.3　getIntegerVal（Integer型でのプロパティ値の取得）

3.10.4　getIntVal（int型でのプロパティ値の取得）

3.10.5　getListRef（List型でのプロパティ値の取得）

3.10.6　getStringVal（String型でのプロパティ値の取得）

3.10.7　getVArrayRef（VARRAY型でのプロパティ値の参照の取得）

3.10.8　getVArrayVal（VARRAY型でのプロパティ値の取得）

3.10.9　isNull（プロパティ値がNULL値かどうかの判定）

3.10.10　setNull（NULL値プロパティの設定）

3.10.11　setPropRef（プロパティ値の参照の設定）

3.10.12　setPropVal（プロパティ値の設定）

3.11　DbjPublicACLIdElmインターフェース

3.11.1　getId（パブリックACLのOIID文字列の取得）

3.11.2　propSet（パブリックACLのOIID文字列のプロパティ値集合の取得）

3.11.3　setId（パブリックACLのOIID文字列の設定）

3.11.4　setPropSet（パブリックACLのOIID文字列のプロパティ値集合の設定）

3.12　DbjQParamインターフェース

3.12.1　getVal（?パラメタ値の取得）

3.13　DbjReferenceContentInfoインターフェース

3.13.1　getContentLocation（コンテンツロケーションの取得）

3.13.2　getReferenceType（リファレンス種別の取得）

3.14　DbjReferencePathInfoインターフェース

3.14.1　getContentOperateMode（コンテンツのパス操作モードの取得）

3.14.2　getDeleteRootPath（削除するディレクトリのルートパスの取得）

3.14.3　getEntry（登録するコンテンツのパスまたはダウンロード先のパスの取得）

3.14.4　getTargetPath（コンテンツ格納先パスの取得）

3.14.5　setContentOperateMode（コンテンツのパス操作モードの設定）

3.14.6　setDeleteRootPath（削除するディレクトリのルートパスの設定）

3.14.7　setEntry（登録するコンテンツのパスまたはダウンロード先のパスの設定）

3.14.8　setTargetPath（コンテンツ格納先パスの設定）

3.15　DbjReferenceUploadInfoインターフェース

3.15.1　getReferencePathInfo（リファレンスファイル文書のパス情報の取得）

3.15.2　setReferencePathInfo（リファレンスファイル文書のパス情報の設定）

3.16　DbjRenditionInfoインターフェース

3.16.1　getRenditionType（レンディションタイプの取得）

3.16.2　propSet（レンディションのプロパティ値集合の取得）

3.17　DbjRenditionListインターフェース

3.17.1　getRenditionInfo（レンディション情報の取得）

3.17.2　getRenditionTypeList（レンディションタイプのリストの取得）

3.18　DbjResultSetインターフェース

3.18.1　absolute（カーソルの絶対指定行への移動）

3.18.2　afterLast（カーソルの最終行の後ろへの移動）

3.18.3　beforeFirst（カーソルの先頭行の前への移動）

3.18.4　distinct（列の重複の排除）

3.18.5　findColumnName（列インデクスの取得）

3.18.6　first（カーソルの先頭行への移動）

3.18.7　getColumnCount（列数の取得）

3.18.8　getColumnMetaName（列名の取得（表名を含む））

3.18.9　getColumnName（列名の取得）

3.18.10　getColumnType（列のデータ型の取得）

3.18.11　getColumnVals（列データの取得）

3.18.12　getIntegerVal（Integer型での列データの取得）

3.18.13　getIntVal（int型での列データの取得）

3.18.14　getObjectRef（データの参照の取得）

3.18.15　getObjectVal（データの取得）

3.18.16　getPropSet（行データをプロパティ値集合として取得）

3.18.17　getRow（カーソル行インデクスの取得）

3.18.18　getRowCount（行数の取得）

3.18.19　getRowVals（行データの取得）

3.18.20　getStringVal（String型での列データの取得）

3.18.21　getTableName（表名の取得）

3.18.22　getVArrayRef（VARRAY型でのデータの参照の取得）

3.18.23　getVArrayVal（VARRAY型でのデータの取得）

3.18.24　isAfterLast（カーソルが最終行の後ろかどうかの判定）

3.18.25　isBeforeFirst（カーソルが先頭行の前かどうかの判定）

3.18.26　isFirst（カーソルが先頭行かどうかの判定）

3.18.27　isLast（カーソルが最終行かどうかの判定）

3.18.28　isNamed（名前付き検索結果かどうかの判定）

3.18.29　isNull（NULL値かどうかの判定）

3.18.30　last（カーソルの最終行への移動）

3.18.31　next（カーソルの次の行への移動）

3.18.32　previous（カーソルの前の行への移動）

3.18.33　reduct（名前なし列の削除）

3.18.34　setColumnMetaName（列名の設定）

3.19　DbjSeedDocQParamインターフェース

3.20　DbjSetDCRLinkInfoインターフェース

3.21　DbjSetLinkInfoインターフェース

3.21.1　getLinkType（リンク種別の取得）

3.21.2　getTargetObj（リンク先オブジェクトの取得）

3.21.3　propSet（リンクオブジェクトのプロパティ値集合の取得）

3.21.4　setPropSet（リンクオブジェクトのプロパティ値集合の設定）

3.21.5　setTargetObj（リンク先オブジェクトの設定）

3.22　DbjSetRCRLinkInfoインターフェース

3.23　DbjSetRelLinkInfoインターフェース

3.24　DbjSetVTFixLinkInfoインターフェース

3.25　DbjSetVTFloatLinkInfoインターフェース

3.26　DbjSetVTLinkInfoインターフェース

3.27　DbjStringQParamインターフェース

3.28　DbjUploadInfoインターフェース

3.28.1　getFilePath（登録する文書のフルパスの取得）

3.28.2　getIndexPath（全文検索インデクス作成用ファイルのフルパスの取得）

3.28.3　getRenditionType（登録する文書のレンディションタイプの取得）

3.28.4　getRetrievalName（登録する文書のファイル名の取得）

3.28.5　renditionPropSet（レンディションプロパティ値集合の取得）

3.28.6　setFilePath（登録する文書のフルパスの設定）

3.28.7　setIndexPath（全文検索インデクス作成用ファイルのフルパスの設定）

3.28.8　setRenditionPropSet（レンディションプロパティ値集合の設定）

3.28.9　setRenditionType（登録する文書のレンディションタイプの設定）

3.28.10　setRetrievalName（登録する文書のファイル名の設定）

3.29　DbjVArrayインターフェース

3.29.1　addPropSet（プロパティ値集合（行）の追加）

3.29.2　addPropVals（プロパティ値（列）の追加）

3.29.3　changePropName（可変長配列オブジェクトのプロパティ名の変更）

3.29.4　changePropNames（可変長配列オブジェクトのプロパティ名の一括変更）

3.29.5　getPropCount（メタプロパティ数の取得）

3.29.6　getPropNameSet（メタプロパティの取得）

3.29.7　getPropVals（可変長配列オブジェクトのプロパティ値のリストの取得）

3.29.8　propSet（プロパティ値集合の取得）

3.29.9　removeProp（プロパティの削除）

3.30　DbjXmlUploadInfoインターフェース

3.30.1　clearParseMessage（構文解析結果メッセージのクリア）

3.30.2　getFilterFilePath（フィルタリング定義ファイルのフルパスの取得）

3.30.3　getIndexType（全文検索インデクスの種別の取得）

3.30.4　getMappingId（マッピング定義名の取得）

3.30.5　getParseLevel（構文解析レベルの取得）

3.30.6　getParseMessage（構文解析結果メッセージの取得）

3.30.7　setFilterFilePath（フィルタリング定義ファイルのフルパスの設定）

3.30.8　setIndexType（全文検索インデクスの種別の設定）

3.30.9　setMappingId（マッピング定義名の設定）

3.30.10　setParseLevel（構文解析レベルの設定）

4.　文書管理クラス詳細

4.1　DbjDocSpaceインターフェース

4.1.1　changeSearchACLMode（検索実行時のアクセス制御モードの変更）

4.1.2　createDocument（バージョンなし文書の作成）

4.1.3　createFolder（バージョンなしフォルダの作成）

4.1.4　createIndependentData（独立データの作成）

4.1.5　createLinkObjList（複数のリンクオブジェクトアクセスインターフェースの取得）

4.1.6　createObjConnection（文書空間オブジェクトアクセスインターフェースの取得）

4.1.7　createObjList（複数の文書空間オブジェクトアクセスインターフェースの取得）

4.1.8　createPublicACL（パブリックACLの作成）

4.1.9　createVrDocument（バージョン付き文書の作成）

4.1.10　createVrFolder（バージョン付きフォルダの作成）

4.1.11　executeSearch（検索の実行）

4.1.12　getMeta（文書空間のメタ情報の取得）

4.1.13　getSearchACLMode（検索実行時のアクセス制御モードの取得）

4.1.14　isAccessControlMode（アクセス制御モードの取得）

4.1.15　removeObjects（検索条件を指定したオブジェクトの削除）

4.2　DbjLinkObjインターフェース

4.2.1　changeToVTFix（構成管理型リンクの構成管理モードをFIXモードに変更）

4.2.2　changeToVTFloat（構成管理型リンクの構成管理モードをFLOATINGモードに変更）

4.2.3　getLinkId（リンク識別子の取得）

4.2.4　getLinkType（リンク種別の取得）

4.2.5　getOwnerObj（リンク元オブジェクトの取得）

4.2.6　getTargetObj（リンク先オブジェクトの取得）

4.2.7　propSet（リンクProxyオブジェクトのプロパティ値集合インターフェースの取得）

4.2.8　readProperties（リンクプロパティの取得）

4.2.9　removeObject（リンクオブジェクトの削除）

4.2.10　setPropSet（リンクProxyオブジェクトのプロパティ値集合の設定）

4.2.11　writeProperties（リンクプロパティ値の設定）

4.3　DbjLinkObjListインターフェース

4.3.1　changeToVTFix（複数の構成管理型リンクの構成管理モードを一括してFIXモードに変更）

4.3.2　changeToVTFloat（複数の構成管理型リンクの構成管理モードを一括してFLOATINGモードに変更）

4.3.3　getLinkIdList（ターゲットリンク識別子プロパティのリストの取得）

4.3.4　getLinkObj（リスト要素のDbjLinkObjインターフェースの取得）

4.3.5　getOwnerObjList（リンク元オブジェクトのリストの取得）

4.3.6　getTargetObjList（リンク先オブジェクトのリストの取得）

4.3.7　readProperties（リンクプロパティ値の一括取得）

4.3.8　removeObjects（リンクオブジェクトの一括削除）

4.3.9　writeProperties（リンクプロパティ値の一括設定）

4.4　DbjObjインターフェース

4.4.1　addRendition（レンディションの追加）

4.4.2　bindPublicACL（パブリックACLのバインド）

4.4.3　cancelCheckOut（バージョン付きオブジェクトのチェックアウトの取り消し）

4.4.4　changeMasterRendition（マスタレンディションの変更）

4.4.5　changeToVTFix（構成管理型リンクの構成管理モードをFIXモードに変更）

4.4.6　changeToVTFloat（構成管理型リンクの構成管理モードをFLOATINGモードに変更）

4.4.7　checkIn（バージョン付きオブジェクトのチェックイン）

4.4.8　checkOut（バージョン付きオブジェクトのチェックアウト）

4.4.9　deleteRendition（レンディションの削除）

4.4.10　deleteVersion（バージョンの削除）

4.4.11　downloadContents（文書のコンテンツのダウンロード）

4.4.12　getBindObjectList（パブリックACLにバインドしている文書空間オブジェクト一覧の取得）

4.4.13　getCheckOutStatus（バージョン付きオブジェクトのチェックアウト状態の取得）

4.4.14　getChildList（フォルダのリンク先オブジェクト（下位オブジェクト）の取得）

4.4.15　getClassName（アクセス対象文書空間オブジェクトを構成するDMAクラス名の取得）

4.4.16　getDCRParent（直接型リンクによるリンク元オブジェクトの取得）

4.4.17　getLockType（Proxyオブジェクトのアクセスロック種別の取得）

4.4.18　getObjType（アクセス対象文書空間オブジェクトのオブジェクト種別の取得）

4.4.19　getOiid（アクセス対象文書空間オブジェクトのOIIDの取得）

4.4.20　getParentList（フォルダのリンク元オブジェクトの取得）

4.4.21　getPublicACLList（バインドしているパブリックACL一覧の取得）

4.4.22　getRelList（文書間リンク一覧の取得）

4.4.23　getRenditionList（レンディション情報一覧の取得）

4.4.24　getTargetVersion（アクセス対象ターゲットバージョンのバージョン識別子の取得）

4.4.25　getVersionId（バージョンオブジェクトのバージョン識別子の取得）

4.4.26　getVersioningInfo（バージョン付きオブジェクトのバージョニングオブジェクトの取得）

4.4.27　getVersionObjList（バージョン付きオブジェクトのバージョン一覧の取得）

4.4.28　link（リンク先オブジェクトとのリンク）

4.4.29　lock（アクセスロック種別の異なる文書空間オブジェクトインターフェースの取得）

4.4.30　move（直接型リンクが設定されている文書空間オブジェクトの移動）

4.4.31　propSet（Proxyオブジェクトのプロパティ値集合インターフェースの取得）

4.4.32　readProperties（文書空間オブジェクトのプロパティ値の読み込み）

4.4.33　removeObject（文書空間オブジェクトの削除）

4.4.34　setPropSet（Proxyオブジェクトのプロパティ値集合の設定）

4.4.35　setTargetVersion（アクセス対象ターゲットバージョンのバージョン識別子の変更）

4.4.36　unbindPublicACL（パブリックACLのアンバインド）

4.4.37　unlink（リンク先オブジェクトとのリンクの解除）

4.4.38　unlinkByLinkId（リンク識別子の指定によるリンク先オブジェクトとのリンクの解除）

4.4.39　uploadContents（文書のコンテンツのアップロード）

4.4.40　writeProperties（文書空間オブジェクトのプロパティ値の設定）

4.4.41　writeRenditionProperties（レンディションプロパティの設定）

4.5　DbjObjListインターフェース

4.5.1　getObj（リスト要素の取得）

4.5.2　lock（アクセスロック種別の異なる複数文書空間オブジェクトインターフェースの取得）

4.5.3　move（直接型リンクが設定されている文書空間オブジェクトの一括移動）

4.5.4　readProperties（複数の文書空間オブジェクトプロパティ値の一括取得）

4.5.5　removeObjects（文書空間オブジェクトの一括削除）

4.5.6　setPropSet（要素のプロパティ値集合の設定）

4.5.7　writeProperties（複数の文書空間オブジェクトプロパティ値の一括設定）

4.6　DbjSessionインターフェース

4.6.1　begin（トランザクションの開始）

4.6.2　checkSession（セッションが有効かどうかのチェック）

4.6.3　commit（トランザクションの確定）

4.6.4　getLoginUserInfo（ユーザ情報の取得）

4.6.5　getReferencePath（コンテンツ格納先ベースパスの取得）

4.6.6　login（ログイン）

4.6.7　logout（ログアウト）

4.6.8　rollback（トランザクションの取り消し）

4.6.9　setReferencePath（コンテンツ格納先ベースパスの設定）

4.7　DbjVerObjインターフェース

4.7.1　getVersionId（文書空間オブジェクトのバージョン識別子の取得）

4.8　DbjVerObjListインターフェース

4.8.1　getVerObj（要素のDbjVerObjインターフェースの取得）

4.8.2　getVersionIdList（文書空間オブジェクトのバージョン識別子リストの取得）

4.9　DbjXmlTranslatorインターフェース

4.9.1　getMappedProperties（XML文書のXMLプロパティマッピング情報の作成）

5.　メタクラス詳細

5.1　DbjClassDescインターフェース

5.1.1　getName（クラス名の取得）

5.1.2　getProperties（プロパティディスクリプションの取得）

5.1.3　getSubClasses（サブクラスのクラスディスクリプションの取得）

5.1.4　getSuperClass（スーパークラスのクラスディスクリプションの取得）

5.2　DbjMetaインターフェース

5.2.1　getClassDesc（指定したクラスのクラスディスクリプションの取得）

5.2.2　getDocSpaceId（文書空間識別子の取得）

5.2.3　getExtFromRenditionType（レンディションタイプに対応する拡張子の取得）

5.2.4　getPropDataType（指定したプロパティのデータ型の取得）

5.2.5　getPropDesc（指定したプロパティのプロパティディスクリプションの取得）

5.2.6　getRenditionType（拡張子に対応するレンディションタイプの取得）

5.3　DbjMetaManagerインターフェース

5.3.1　getMeta（メタ情報の取得）

5.4　DbjPropDescインターフェース

5.4.1　getDataType（プロパティのデータ型の取得）

5.4.2　getName（プロパティ名の取得）

5.4.3　getVArrayClass（VARRAY型プロパティを扱うクラスのクラスディスクリプションの取得）

6.　例外クラス詳細

6.1　例外クラスの詳細

6.2　DbjAccessControlExceptionクラス

6.3　DbjAccessControlNotSupportedExceptionクラス

6.4　DbjACEOperationExceptionクラス

6.5　DbjACLOutOfRangeExceptionクラス

6.6　DbjAlreadyCheckOutExceptionクラス

6.7　DbjCheckOutExceptionクラス

6.8　DbjContentNotRegisteredExceptionクラス

6.9　DbjContentTypeMismatchExceptionクラス

6.10　DbjCORBAExceptionクラス

6.11　DbjDBDeadLockExceptionクラス

6.12　DbjDBExceptionクラス

6.13　DbjDBLockTimeoutExceptionクラス

6.14　DbjDisconnectedSessionExceptionクラス

6.15　DbjErrorクラス

6.16　DbjExceptionクラス

6.17　DbjFileAccessExceptionクラス

6.18　DbjFileNotFoundExceptionクラス

6.19　DbjFileReferenceCurrentContentNotfoundExceptionクラス

6.20　DbjFileReferenceMismatchStatusExceptionクラス

6.21　DbjFileReferenceOperationFailedExceptionクラス

6.22　DbjIllegalCacheStartIndexExceptionクラス

6.23　DbjIllegalDocSpaceIdExceptionクラス

6.24　DbjIllegalObjectTypeExceptionクラス

6.25　DbjIllegalPropValExceptionクラス

6.26　DbjInitializeErrorクラス

6.27　DbjInternalErrorクラス

6.28　DbjIOExceptionクラス

6.29　DbjIsMasterRenditionExceptionクラス

6.30　DbjLastVersionExceptionクラス

6.31　DbjMasterRenditionNotSetExceptionクラス

6.32　DbjNotAuthenticatedExceptionクラス

6.33　DbjNotCheckOutExceptionクラス

6.34　DbjNotLoginExceptionクラス

6.35　DbjObjectNotFoundExceptionクラス

6.36　DbjOutOfMemoryErrorクラス

6.37　DbjPublicACLAlreadyBoundExceptionクラス

6.38　DbjPublicACLNotBoundExceptionクラス

6.39　DbjPublicACLNotFoundExceptionクラス

6.40　DbjPublicACLOperationExceptionクラス

6.41　DbjPublicACLOutOfRangeExceptionクラス

6.42　DbjReferenceTypeMismatchExceptionクラス

6.43　DbjRenditionCountOutOfRangeExceptionクラス

6.44　DbjRenditionIsEmptyExceptionクラス

6.45　DbjRenditionNotConvertedExceptionクラス

6.46　DbjRenditionNotFoundExceptionクラス

6.47　DbjRenditionTypeDuplicatedExceptionクラス

6.48　DbjSessionExceptionクラス

6.49　DbjSessionNotConnectExceptionクラス

6.50　DbjSessionOverflowExceptionクラス

6.51　DbjSubjectLengthOutOfRangeExceptionクラス

6.52　DbjTargetContentPathNotSetExceptionクラス

6.53　DbjUnknownErrorクラス

6.54　DbjXmlParseExceptionクラス

7.　定数定義クラス詳細

7.1　DbjDefクラス

7.1.1　Category：ACL

7.1.2　Category：DATATYPE

7.1.3　Category：DMA BOOLEAN

7.1.4　Category：INDEXTYPE

7.1.5　Category：LINK

7.1.6　Category：LOCK

7.1.7　Category：OBJTYPE

7.1.8　Category：OPERATEMODE

7.1.9　Category：ORDER

7.1.10　Category：PERM

7.1.11　Category：PRIV

7.1.12　Category：REFERENCETYPE

7.1.13　Category：RELATIONEND

7.1.14　Category：RENDSTATUS

7.1.15　Category：SUBJECTTYPE

7.1.16　Category：SYSSUBJECT

7.1.17　Category：XMLPARSE

7.1.18　Category：Others

7.2　DbjTraceDefクラス

7.2.1　Category：TRACELEVEL

7.2.2　Category：TRACEOUTPUT

8.　ライブラリ情報取得クラス詳細

8.1　DbjLibInfoクラス

8.1.1　getVersion（バージョンの取得）

9.　トレースクラス詳細

9.1　DbjTraceクラス

9.1.1　arg（パラメタ情報の出力）

9.1.2　call（外部APIの呼び出し情報の出力）

9.1.3　DbjTrace（コンストラクタ）

9.1.4　enter（メソッドの入り口情報の出力）

9.1.5　error（エラー情報の出力）

9.1.6　exit（メソッドの出口情報の出力）

9.1.7　hint（下位のメソッドのエラー情報の出力）

9.1.8　init（トレースクラスの初期化）

9.1.9　msg（メッセージの出力）

9.1.10　returned（外部APIからのリターン情報の出力）

10.　メッセージの一覧

10.1　メッセージの形式と見方

10.2　メッセージの詳細

KMBJ00001-E

KMBJ00002-E

KMBJ00003-E

KMBJ00004-E

KMBJ00005-E

KMBJ00006-E

KMBJ00007-E

KMBJ00008-E

KMBJ00009-E

KMBJ00010-E

KMBJ00011-E

KMBJ00012-E

KMBJ00013-E

KMBJ00014-E

KMBJ00015-E

KMBJ00016-E

KMBJ00017-E

KMBJ00018-E

KMBJ00019-E

KMBJ00020-E

KMBJ00021-E

KMBJ00022-E

KMBJ00023-E

KMBJ00024-E

KMBJ00025-E

KMBJ00026-E

KMBJ00027-E

KMBJ00028-E

KMBJ00029-E

KMBJ00030-E

KMBJ00031-E

KMBJ00032-E

KMBJ00033-E

KMBJ00034-E

KMBJ00035-E

KMBJ00036-E

KMBJ00037-E

KMBJ00038-E

KMBJ00039-E

KMBJ00040-E

KMBJ00041-E

KMBJ00042-E

KMBJ00043-E

KMBJ00044-E

KMBJ00045-E

KMBJ00046-E

KMBJ00047-E

KMBJ00048-E

KMBJ00049-E

KMBJ00050-E

KMBJ00051-E

KMBJ00052-E

KMBJ00053-E

KMBJ00054-E

KMBJ00055-E

KMBJ00056-E

KMBJ00057-E

KMBJ00058-E

KMBJ00059-E

KMBJ00060-E

KMBJ00061-E

KMBJ00062-E

KMBJ00063-E

KMBJ00064-E

KMBJ00065-E

KMBJ00066-E

KMBJ00067-E

KMBJ00068-E

KMBJ00069-E

KMBJ00070-E

KMBJ00071-W

KMBJ00072-E

KMBJ00073-E

KMBJ00074-E

KMBJ00075-E

KMBJ00076-E

KMBJ00077-E

KMBJ00078-E

KMBJ00079-E

KMBJ00080-E

KMBJ00081-E

KMBJ00082-E

KMBJ00083-E

KMBJ00084-E

KMBJ00085-E

KMBJ00086-E

KMBJ00087-E

KMBJ00088-E

KMBJ00089-W

KMBJ00090-W

KMBJ00091-W

KMBJ00092-E

KMBJ00093-E

KMBJ00094-E

KMBJ00095-E

KMBJ00096-E

KMBJ00097-E

KMBJ00098-E

KMBJ00099-E

KMBJ00100-E

KMBJ00101-E

KMBJ00102-E

KMBJ00103-E

KMBJ00104-E

KMBJ00105-E

KMBJ00106-E

KMBJ00107-E

KMBJ00108-E

KMBJ00109-E

KMBJ00110-E

KMBJ00111-E

KMBJ00112-E

KMBJ00113-E

KMBJ00114-E

KMBJ00115-E

KMBJ00116-W

KMBJ00117-E

KMBJ00118-W

KMBJ00119-E

KMBJ00120-E

KMBJ00121-E

KMBJ00122-E

KMBJ00123-E

KMBJ00124-E

KMBJ00125-E

KMBJ00126-E

KMBJ00127-E

KMBJ00128-E

KMBJ00129-E

KMBJ00132-E

KMBJ00133-E

KMBJ00134-E

付録

付録A　文書空間で使用する文字コード種別がUTF-8の場合の機能差異

付録B　用語解説

索引

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.

前書き

■ 対象製品

R-1M95D-43※　 uCosminexus DocumentBroker Development Kit Version 3　 03-60（適用OS：AIX 5L V5.1，AIX 5L V5.2，AIX 5L V5.3）
R-1595D-43　 uCosminexus DocumentBroker Development Kit Version 3　 03-70（適用OS：Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 x64 Edition，Windows Server 2008 x86，Windows Server 2008 R2，Windows Server 2012，Windows XP，Windows Vista，Windows 7，Windows 8）

これらのプログラムプロダクトのほかにもこのマニュアルをご利用になれる場合があります。詳細は「リリースノート」でご確認ください。
※印の製品については，サポート時期をご確認ください。

■ 輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。
なお、不明な場合は、弊社担当営業にお問い合わせください。

■ 商標類

Active Directoryは，米国Microsoft Corporationの，米国およびその他の国における登録商標または商標です。
AIXは，米国およびその他の国におけるInternational Business Machines Corporationの商標です。
CORBAは，Object Management Groupが提唱する分散処理環境アーキテクチャの名称です。
GIFは，米国CompuServe Inc.が開発したフォーマットの名称です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Microsoft Office Wordは，米国Microsoft Corporationの商品名称です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Microsoft Office Wordは，米国Microsoft Corporationの商品名称です。
OLEは，米国Microsoft Corporationが開発したソフトウェア名称です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
TIFFは，米国Aldus Corp.が開発したフォーマットの名称です。
UNIXは，The Open Groupの米国ならびに他の国における登録商標です。
Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Vistaは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
活文，PDFstaffは，株式会社日立ソリューションズの登録商標です。
その他記載の会社名，製品名は，それぞれの会社の商標もしくは登録商標です。

■ 発行

2013年9月 3000-3-F17-20

■ 著作権

All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.

変更内容

変更内容（3000-3-F17-20）DocumentBroker Development Kit Version 3　03-70（適用OS：Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 x64 Edition，Windows Server 2008 x86，Windows Server 2008 x64，Windows Server 2008 R2，Windows Server 2012，Windows XP，Windows Vista，Windows 7，Windows 8）

追加・変更内容
変更個所

次の前提OSをサポートしました。

Windows Server 2012

Windows 8

－

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルは，次に示すプログラムプロダクトで提供するJava クラスライブラリの詳細，インターフェースの詳細，メソッドの文法，およびメッセージの詳細についてリファレンス形式で説明したものです。

R-1M95D-43　uCosminexus DocumentBroker Development Kit Version 3

R-1595D-43　uCosminexus DocumentBroker Development Kit Version 3

対象読者

このマニュアルは，uCosminexus DocumentBroker Development Kitが提供するJava クラスライブラリを使用して，ユーザアプリケーションプログラムを開発し，システムを構築，運用および管理する方を対象にしています。なお，次の内容を理解されていることを前提としています。

UNIXまたはWindowsに関する知識

JavaTM言語に関する知識

XMLに関する知識

SQL言語に関する知識

マニュアルの構成

このマニュアルは，次に示す章と付録から構成されています。

第1章　Java クラスライブラリのクラス，インターフェース，およびメソッド

Java クラスライブラリのクラス，インターフェース，およびメソッドを一覧表形式で説明しています。また，Java クラスライブラリで提供するクラスライブラリのリファレンスマニュアルのクラス，インターフェース，およびメソッドの記述形式（ページレイアウト）について説明しています。

第2章　ファクトリクラス詳細

ファクトリクラスのクラス，インターフェース，およびメソッドについて説明しています。

第3章　パラメタクラス詳細

パラメタクラスのインターフェース，およびメソッドについて説明しています。

第4章　文書管理クラス詳細

文書管理クラスのインターフェース，およびメソッドについて説明しています。

第5章　メタクラス詳細

メタクラスのインターフェース，およびメソッドについて説明しています。

第6章　例外クラス詳細

例外クラスの詳細について説明しています。

第7章　定数定義クラス詳細

定数定義クラスの定義内容についてカテゴリごとに説明しています。

第8章　ライブラリ情報取得クラス詳細

ライブラリ情報取得クラスのクラスとそのメソッドについて説明しています。

第9章　トレースクラス詳細

トレースクラスのクラスとそのメソッドについて説明しています。

第10章　メッセージの一覧

Java クラスライブラリが出力するメッセージについて説明しています。

付録A　文書空間で使用する文字コード種別がUTF-8の場合の機能差異

文書空間で使用する文字コード種別がUTF-8の場合のクラス，インターフェースおよびメソッドの機能差異について説明しています。

付録B　用語解説

Java クラスライブラリで使用する用語について説明しています。

関連マニュアル

このマニュアルは次のマニュアルと関連がありますので，必要に応じてお読みください。なお，本文に記載のマニュアル名称は，「uCosminexus DocumentBroker」を「DocumentBroker」と表記しています。

uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説（3000-3-F16）

Java クラスライブラリの機能および環境設定のしかたについて知りたい場合に参照してください。

uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　サンプルWebアプリケーション（3000-3-F18）

uCosminexus DocumentBroker Development KitおよびuCosminexus DocumentBroker Runtimeが提供しているJava クラスライブラリを使用したサンプルWebアプリケーションの機能と使用方法，およびサンプルWebアプリケーションを参考にしたWebアプリケーションの開発方法について知りたい場合に参照してください。

DocumentBroker Version 3　システム導入・運用ガイド　（3000-3-D01）

uCosminexus DocumentBroker Version 3　システム導入・運用ガイド　（3020-3-U71）

uCosminexus DocumentBrokerを使用する環境を定義，管理および運用する場合に参照してください。

UNIXの場合は，資料番号が3000-3-D01のマニュアルを参照してください。

Windowsの場合は，資料番号が3020-3-U71のマニュアルを参照してください。

uCosminexus DocumentBroker Version 3　メッセージ（3000-3-F12）

uCosminexus DocumentBrokerが出力するメッセージについて知りたい場合に参照してください。

読書手順

このマニュアルは，利用目的に合わせて章を選択してお読みいただけます。次に示す表を参考にして，お読みになる章を選択してください。

このマニュアルを読む目的 | 記述個所
どのようなJava クラスライブラリのクラス，インターフェースおよびメソッドがあるかを知りたい | 1章
クラス，インターフェースおよびメソッドの説明形式について知りたい | 1.9節
ファクトリクラスのインターフェースおよびメソッドについて知りたい | 2章
パラメタクラスのインターフェースおよびメソッドについて知りたい | 3章
文書管理クラスのインターフェースおよびメソッドについて知りたい | 4章
メタクラスのインターフェースおよびメソッドについて知りたい | 5章
例外クラスについて知りたい | 6章
定数定義クラスの定義内容について知りたい | 7章
ライブラリ情報取得クラスのクラスおよびメソッドについて知りたい | 8章
トレースクラスのクラスおよびメソッドについて知りたい | 9章
出力されるメッセージについて知りたい | 10章
文書空間で使用する文字コード種別がUTF-8の場合のクラス，インターフェースおよびメソッドの機能差異について知りたい | 付録A
uCosminexus DocumentBrokerの用語を知りたい | 付録B

このマニュアルでの表記

このマニュアルでは，製品名称を次に示す略称で表記しています。

製品名称 | 略称
AIX 5L V5.1 | AIX
AIX 5L V5.2
AIX 5L V5.3
uCosminexus DocumentBroker Development Kit Version 3 | DocumentBroker
uCosminexus DocumentBroker Runtime Version 3
uCosminexus DocumentBroker Server Version 3
uCosminexus DocumentBroker Development Kit Version 3 | DocumentBroker Development Kit
uCosminexus DocumentBroker Runtime Version 3 | DocumentBroker Runtime
uCosminexus DocumentBroker Server Version 3 | DocumentBrokerサーバ
Microsoft(R) Active Directory(R) | Active Directory
Microsoft(R) Office Word | Word
Microsoft(R) Word
Microsoft(R) Windows Server(R) 2003, Enterprise Edition 日本語版 | Windows Server 2003
Microsoft(R) Windows Server(R) 2003, Standard Edition 日本語版
Microsoft(R) Windows Server(R) 2003 R2, Enterprise Edition 日本語版 | Windows Server 2003 R2
Microsoft(R) Windows Server(R) 2003 R2, Standard Edition 日本語版
Microsoft(R) Windows Server(R) 2003 R2, Enterprise x64 Edition 日本語版 | Windows Server 2003 R2またはWindows Server 2003 R2 x64 Edition
Microsoft(R) Windows Server(R) 2003 R2, Standard x64 Edition 日本語版
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版 | Windows Server 2008 またはWindows Server 2008 x86
Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日本語版
Microsoft(R) Windows Server(R) 2008 R2 Enterprise 日本語版 | Windows Server 2008 R2
Microsoft(R) Windows Server(R) 2008 R2 Standard 日本語版
Microsoft(R) Windows Server(R) 2012 Standard 日本語版 | Windows Server 2012
Microsoft(R) Windows Server(R) 2012 Datacenter 日本語版
Microsoft(R) Windows(R) XP Professional Operating System | Windows XP
Microsoft(R) Windows Vista(R) Ultimate 日本語版 | Windows Vista
Microsoft(R) Windows Vista(R) Business 日本語版
Microsoft(R) Windows Vista(R) Enterprise 日本語版
Microsoft(R) Windows(R) 7 Professional 日本語版 (32ビット版) | Windows 7
Microsoft(R) Windows(R) 7 Enterprise 日本語版 (32ビット版)
Microsoft(R) Windows(R) 7 Ultimate 日本語版 (32ビット版)
Microsoft(R) Windows(R) 7 Professional 日本語版 (64ビット版)
Microsoft(R) Windows(R) 7 Enterprise 日本語版 (64ビット版)
Microsoft(R) Windows(R) 7 Ultimate 日本語版 (64ビット版)
Windows(R) 8 Pro 日本語版（32ビット版） | Windows 8
Windows(R) 8 Pro 日本語版（64ビット版）
Windows(R) 8 Enterprise 日本語版（32ビット版）
Windows(R) 8 Enterprise 日本語版（64ビット版）
Sun Java(TM) System Directory Server 5.1 | Sun Java System Directory Server
Sun Java(TM) System Directory Server 5.2
Sun Java(TM) System Directory Server 6.3

このほか，このマニュアルでは，次に示す表記方法を使用しています。

JavaTMをJavaと表記します。

uCosminexus DocumentBroker Development KitおよびuCosminexus DocumentBroker Runtimeが提供するJava言語対応のクラスライブラリをJava クラスライブラリと表記します。

AIXをUNIXと表記することがあります。

Windows Server 2003，Windows Server 2003 R2，Windows Server 2003 R2 x64 Edition，Windows Server 2008 x86，Windows Server 2008 R2，Windows Server 2012，Windows XP，Windows Vista，Windows 7，およびWindows 8を合わせてWindowsと表記することがあります。

uCosminexus DocumentBrokerのマニュアルで使用する略語

uCosminexus DocumentBrokerのマニュアルで使用する英略語を次に示します。

英略語 | 英字での表記
ACE | Access Control Element
ACFlag | Access Control Flag
ACL | Access Control List
AIIM | Association for Information and Image Management International
API | Application Programming Interface
ASCII | American Standard Code for Information Interchange
BES | Back End Server
BLOB | Binary Large Object
BMP | Bit Map
BNF | Backus Normal Form
BOA | Basic Object Adapter
CD-ROM | Compact Disc Read Only Memory
CGI | Common Gateway Interface
CORBA | Common Object Request Broker Architecture
CPU | Central Processing Unit
CR | Carriage Return
CSV | Comma Separated Value
DAP | Directory Access Protocol
DAT | Digital Audio Tape
DB | Database
DBMS | Database Management System
DCD | Document Content Description
DDE | Dynamic Data Exchange
DIT | Directory Information Tree
DLL | Dynamic Linking Library
DMA | Document Management Alliance
DN | Distinguished Name
DTD | Document Type Definition
EOF | End of File
ESIS-B | Element Structure Information Set-Binary Format
EUC | Extended UNIX Code
FAM | File Access Module
GIF | Graphics Interchange Format
GUI | Graphical User Interface
GUID | Globally Unique Identifier
HTML | Hypertext Markup Language
HTTP | Hypertext Transfer Protocol
IANA | Internet Assigned Numbers Authority
ID | Identifier
IPF | Itanium(R) Processor Family
ISO | International Organization for Standardization
JIS | Japanese Industrial Standards
JPEG | Joint Photographic Expert Group
LAN | Local Area Network
LDAP | Lightweight Directory Access Protocol
LF | Line Feed
MFC | Microsoft Foundation Class
MIME | Multipurpose Internet Mail Extensions
OCR | Optical Character Reader
OIID | Object Instance Identifier
OLE | Object Linking and Embedding
OMG | Object Management Group
ORB | Object Request Broker
ORDB | Object Relational Database
OS | Operating System
OTS | Object Transaction Service
PC | Personal Computer
PDF | Portable Document Format
RDB | Relational Database
RDN | Relative Distinguished Name
RFC | Request for Comment
RTF | Rich Text Format
SQL | Structured Query Language
TCP/IP | Transmission Control Protocol/Internet Protocol
TIFF | Tag Image File Format
UOC | User Own Coding
URL | Uniform Resource Locator
UTC | Universal Time Coordinated
UTF-8 | 8-bit UCS Transformation Format
W3C | World Wide Web Consortium
WWW | World Wide Web
XML | Extensible Markup Language

このマニュアルで使用する記号

このマニュアルで使用する記号を次に示します。

記号
意味

　｜
横に並べられた複数の項目に対する項目間の区切りを示し，「または」の意味を表します。

（例）　A｜B

AまたはBを指定することを示します。

　＿
括弧で囲まれた複数項目のうち1項目に対し使用され，括弧内のすべてを省略した場合にシステムが取る標準値を示します。

（例）　〔A｜B〕

何も指定しない場合はAが仮定されます。

｛　｝
この記号で囲まれている複数の項目のうちから一つを選択することを示します。項目が横に並べられ，記号｜で区切られている場合は，そのうちの一つを選択します。

（例）　｛A｜B｜C｝

A，BまたはCのどれかを指定することを示します。

〔　〕
この記号で囲まれている項目は省略してもよいことを意味します。複数の項目が横に並べて記述されている場合には，すべてを省略するか，記号｛ ｝と同じくどれか一つを選択します。

（例１）　〔A〕

「何も指定しない」か「Aを指定する」ことを示します。

（例２）　〔B｜C〕

「何も指定しない」か「BまたはCを指定する」ことを示します。

<　>
この記号で囲まれている項目は，該当する要素を指定することを示します。

（例）　<プロパティ>

プロパティを記述します。

：：＝
この記号の左にあるものを右にあるもので定義することを示します。

（例）　A：：＝B

「AとはBである」と定義することを示します。

　…
記述が省略されていることを示します。

（例）　ABC…

ABCの後ろに記述があり，その記述が省略されていることを示します。

．．．
この記号の直前の項目を繰り返し，複数個指定できることを示します。

（例）　A．．．

Aを複数個指定できることを示します。

このマニュアルで使用する構文要素記号

このマニュアルで使用する構文要素の種類を次に示します。

構文要素記号 | 意味
英字 | A～Z　a～z
英小文字 | a～z
英大文字 | A～Z
数字 | 0～9
英数字 | A～Z　a～z　0～9
16進数字 | 0～9　A～F　a～f
記号 | !　"　#　$　%　&　'　(　)　+　,　_　―　・　.　/　:　;　<　=　>　@　[　]　^　－　｛　｝　￣　空白　¥

注　すべて半角文字を使用してください。

常用漢字以外の漢字の使用について

このマニュアルでは，常用漢字を使用することを基本としていますが，次に示す用語については，常用漢字以外の漢字を使用しています。

個所（かしょ）

KB（キロバイト）などの単位表記について

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

DocumentBroker Version 2とuCosminexus DocumentBroker Version 3の製品体系の違い

uCosminexus DocumentBroker Version 3では次のように製品の統合を行いました。

DocumentBroker RepositoryをuCosminexus DocumentBroker Serverに統合しました。

DocumentBroker Web ComponentをuCosminexus DocumentBroker Development KitおよびuCosminexus DocumentBroker Runtimeに統合しました。

DocumentBroker Version 2とuCosminexus DocumentBroker Version 3の製品体系の違いを次に示します。

DocumentBroker Version 2とuCosminexus DocumentBroker Version 3のマニュアルの対応

バージョンアップおよび製品体系の変更に伴い，uCosminexus DocumentBroker Version 3では次に示すようにマニュアル名称を変更しました。

Version 2のマニュアル名称 | Version 3のマニュアル名称
DocumentBroker Version 2　システム導入・運用ガイド | uCosminexus DocumentBroker Version 3　システム導入・運用ガイド
DocumentBroker Version 2　クラスライブラリ　解説 | uCosminexus DocumentBroker Version 3　クラスライブラリ　C++　解説
DocumentBroker Version 2　クラスライブラリ　リファレンス　基本機能編 | uCosminexus DocumentBroker Version 3　クラスライブラリ　C++　リファレンス　基本機能編
DocumentBroker Version 2　クラスライブラリ　リファレンス　概念SGML文書管理機能編 | 廃版
DocumentBroker Version 2　オブジェクト操作ツール | uCosminexus DocumentBroker Version 3　オブジェクト操作ツール
DocumentBroker Version 2　統計解析ツール | uCosminexus DocumentBroker Version 3　統計解析ツール
DocumentBroker Version 2　メッセージ | uCosminexus DocumentBroker Version 3　メッセージ
DocumentBroker Web Component Version 2　解説 | uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　解説
DocumentBroker Web Component Version 2　リファレンス | uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　リファレンス
DocumentBroker Web Component Version 2　サンプルWebアプリケーション | uCosminexus DocumentBroker Version 3　クラスライブラリ　Java　サンプルWebアプリケーション
DocumentBroker Text Search Index Loader Version 2 | uCosminexus DocumentBroker Text Search Index Loader Version 3
DocumentBroker Rendering Option　システム導入・運用ガイド | uCosminexus DocumentBroker Rendering Option Version 3
DocumentBroker Object Loader Version 2 | uCosminexus DocumentBroker Object Loader Version 3

1.　Java クラスライブラリのクラス，インターフェース，およびメソッド

この章では，Java クラスライブラリで使用するクラス，インターフェース，およびメソッドについて説明します。文書空間で使用する文字コード種別がUTF-8の場合のクラス，インターフェースおよびメソッドの機能差異については，「付録A　文書空間で使用する文字コード種別がUTF-8の場合の機能差異」を参照してください。

＜この章の構成＞

1.1　ファクトリクラスのインターフェース，およびメソッド一覧

1.2　パラメタクラスのインターフェース，およびメソッド一覧

1.3　文書管理クラスのインターフェース，およびメソッド一覧

1.4　メタクラスのインターフェース，およびメソッド一覧

1.5　例外クラスのクラス一覧，スーパークラス，およびコンストラクタ

1.6　定数定義クラスのカテゴリ一覧

1.7　ライブラリ情報取得クラスのクラス，およびメソッド一覧

1.8　トレースクラスのクラス，およびメソッド一覧

1.9　クラス，インターフェースおよびメソッドの説明形式

1.1　ファクトリクラスのインターフェース，およびメソッド一覧

ファクトリクラスのクラス，およびメソッドを一覧形式で説明します。

＜この節の構成＞

1.1.1　ファクトリクラスのクラスおよびインターフェース

1.1.2　ファクトリクラスのメソッド一覧

1.1.1　ファクトリクラスのクラスおよびインターフェース

ファクトリクラスのクラスおよびインターフェースを表1-1に示します。なお，それぞれのクラスおよびインターフェースの使用方法については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「6.4　ファクトリクラス」を参照してください。

表1-1　ファクトリクラスのクラスおよびインターフェース一覧

クラス・インターフェース | 説明
ファクトリインターフェースを取得するためのクラス
DbjFactory0200クラス | Java クラスライブラリのファクトリインターフェースを取得するためのクラス
ファクトリインターフェース
DbjFactoryインターフェース | Java クラスライブラリのオブジェクトを生成し，そのインターフェースを返却するファクトリインターフェース

1.1.2　ファクトリクラスのメソッド一覧

ファクトリクラスのクラス，およびインターフェースのメソッドの一覧を示します。

＜この項の構成＞

(1)　DbjFactory0200クラス（Java クラスライブラリのDbjFactoryインターフェースを取得するためのクラス）

(2)　DbjFactoryインターフェース（オブジェクトを生成するためのインターフェース）

(1)　DbjFactory0200クラス（Java クラスライブラリのDbjFactoryインターフェースを取得するためのクラス）

DbjFactory0200クラスのメソッド一覧を表1-2に示します。

表1-2　DbjFactory0200クラスのメソッド一覧

メソッド | 機能
getFactory | ファクトリインターフェースの取得
getMetaManager | メタマネージャーインターフェースの取得

(2)　DbjFactoryインターフェース（オブジェクトを生成するためのインターフェース）

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

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

メソッド | 機能
Java クラスライブラリ上のオブジェクトを作成するメソッド
createACE | ACEの作成
createBooleanQParam | BOOL型の?パラメタの作成
createFetchInfo | 検索結果取得情報オブジェクトの作成
createInteger32QParam | INT型の?パラメタの作成
createOIIDQParam | OIIDの?パラメタの作成
createObjQParam | Object型の?パラメタの作成
createPropSet | プロパティ値集合オブジェクトの作成
createPublicACLIdElm | パブリックACLのOIIDエレメントの作成
createReferencePathInfo | リファレンスファイル文書のパス情報オブジェクトの作成
createReferenceUploadInfo | リファレンスファイル文書のアップロード情報オブジェクトの作成
createSeedDocQParam | 種文章の?パラメタの作成
createSession | Java クラスライブラリのセッションオブジェクトの作成
createSetDCRLinkInfo | 直接型リンク設定情報の作成
createSetRCRLinkInfo | 参照型リンク設定情報の作成
createSetRelLinkInfo | 文書間リンク設定情報の作成
createSetVTFixLinkInfo | 構成管理モードがFIXモードの構成管理型リンク設定情報の作成
createSetVTFloatLinkInfo | 構成管理モードがFLOATINGモードの構成管理型リンク設定情報の作成
createStringQParam | STR型の?パラメタの作成
createUploadInfo | 文書のアップロード情報オブジェクトの作成
createVArray | 可変長配列オブジェクトの作成
createXmlTranslator | XMLトランスレーターの取得
createXmlUploadInfo | XML文書のアップロード情報オブジェクトの作成

1.2　パラメタクラスのインターフェース，およびメソッド一覧

パラメタクラスのインターフェース，およびメソッドを一覧形式で説明します。

＜この節の構成＞

1.2.1　パラメタクラスのインターフェース一覧

1.2.2　パラメタクラスのメソッド一覧

1.2.1　パラメタクラスのインターフェース一覧

パラメタクラスのインターフェースの一覧を表1-4に示します。なお，それぞれのインターフェースの機能については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「6.5　パラメタの操作」を参照してください。

表1-4　パラメタクラスのインターフェース一覧

インターフェース | 説明
?パラメタを扱うインターフェース
DbjBooleanQParamインターフェース | BOOL型を表す?パラメタを扱うインターフェース
DbjInteger32QParamインターフェース | INT型を表す?パラメタを扱うインターフェース
DbjObjQParamインターフェース | 文書空間オブジェクトを表す?パラメタを扱うインターフェース
DbjOIIDQParamインターフェース | OIID文字列を表す?パラメタを扱うインターフェース
DbjQParamインターフェース | 検索メソッドで指定する?パラメタリストの要素となるインターフェースのスーパーインターフェース
DbjSeedDocQParamインターフェース | 種文章を表す?パラメタを扱うインターフェース
DbjStringQParamインターフェース | STR型を表す?パラメタを扱うインターフェース
XMLプロパティマッピング結果情報を扱うインターフェース
DbjMappedPropインターフェース | XMLプロパティマッピング機能を実行して取得した情報を扱うインターフェース
アクセス制御用プロパティを扱うインターフェース
DbjACEインターフェース | ACEの値を扱うインターフェース
DbjPublicACLIdElmインターフェース | 文書空間オブジェクトにバインドするパブリックACLのOIID文字列を扱うインターフェース
アップロード情報を扱うインターフェース
DbjReferenceUploadInfoインターフェース | リファレンスファイル文書のアップロード情報を扱うインターフェース
DbjUploadInfoインターフェース | 文書のアップロード情報を扱うインターフェース
DbjXmlUploadInfoインターフェース | XML文書のアップロード情報を扱うインターフェース
可変長配列オブジェクトを扱うインターフェース
DbjVArrayインターフェース | VARRAY型プロパティの値である可変長配列オブジェクトを扱うインターフェース
検索結果集合を扱うインターフェース
DbjResultSetインターフェース | 検索結果集合を扱うインターフェース
検索結果取得情報を扱うインターフェース
DbjFetchInfoインターフェース | 検索結果取得情報を扱うインターフェース
チェックアウト情報を扱うインターフェース
DbjCheckOutInfoインターフェース | バージョン付きオブジェクトのチェックアウト情報を扱うインターフェース
プロパティ値集合を扱うインターフェース
DbjPropSetインターフェース | プロパティ値集合を扱うインターフェース
文書のコンテンツ情報を扱うインターフェース
DbjContentInfoインターフェース | 文書のコンテンツ情報を扱うインターフェース
DbjReferenceContentInfoインターフェース | リファレンスファイル文書のコンテンツ情報を扱うインターフェース
文書のパス情報を扱うインターフェース
DbjReferencePathInfoインターフェース | リファレンスファイル文書のパス情報を扱うインターフェース
リンクの設定情報を扱うインターフェース
DbjSetDCRLinkInfoインターフェース | 直接型リンクの設定情報を扱うインターフェース
DbjSetLinkInfoインターフェース | リンクの設定情報を扱うインターフェース
DbjSetRCRLinkInfoインターフェース | 参照型リンクの設定情報を扱うインターフェース
DbjSetRelLinkInfoインターフェース | 文書間リンクの設定情報を扱うインターフェース
DbjSetVTFixLinkInfoインターフェース | 構成管理型リンク（構成管理モードはFIXモード）の設定情報を扱うインターフェース
DbjSetVTFloatLinkInfoインターフェース | 構成管理型リンク（構成管理モードはFLOATINGモード）の設定情報を扱うインターフェース
DbjSetVTLinkInfoインターフェース | 構成管理型リンクの設定情報を扱うインターフェースのスーパーインターフェース
レンディション情報を扱うインターフェース
DbjRenditionInfoインターフェース | レンディション情報を扱うインターフェース
DbjRenditionListインターフェース | レンディション情報のリストを扱うインターフェース

Java クラスライブラリで提供しているこれらのインターフェースには継承関係があり，上位にあるインターフェースで定義したプロパティやメソッドは，下位のインターフェースに継承されます。インターフェースの継承関係を図1-1に示します。

図1-1　パラメタクラスのインターフェースの継承関係

1.2.2　パラメタクラスのメソッド一覧

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

＜この項の構成＞

(1)　DbjACEインターフェース（ACEの値を扱うインターフェース）

(2)　DbjCheckOutInfoインターフェース（バージョン付きオブジェクトのチェックアウト情報を扱うインターフェース）

(3)　DbjContentInfoインターフェース（文書のコンテンツ情報を扱うインターフェース）

(4)　DbjFetchInfoインターフェース（検索結果取得情報を扱うインターフェース）

(5)　DbjMappedPropインターフェース（XMLプロパティマッピング結果情報を扱うインターフェース）

(6)　DbjPropSetインターフェース（プロパティ値集合を扱うインターフェース）

(7)　DbjPublicACLIdElmインターフェース（パブリックACLのOIID文字列を扱うインターフェース）

(8)　DbjQParamインターフェース

(9)　DbjReferenceContentInfoインターフェース（リファレンスファイル文書のコンテンツ情報を扱うインターフェース）

(10)　DbjReferencePathInfoインターフェース（リファレンスファイル文書のパス情報を扱うインターフェース）

(11)　DbjReferenceUploadInfoインターフェース（リファレンスファイル文書のアップロード情報を扱うインターフェース）

(12)　DbjRenditionInfoインターフェース（レンディション情報を扱うインターフェース）

(13)　DbjRenditionListインターフェース（レンディション情報のリストを扱うインターフェース）

(14)　DbjResultSetインターフェース（検索結果集合を扱うインターフェース）

(15)　DbjSetLinkInfoインターフェース（リンクの設定情報を扱うインターフェース）

(16)　DbjUploadInfoインターフェース（文書のアップロード情報を扱うインターフェース）

(17)　DbjVArrayインターフェース（可変長配列オブジェクトを扱うインターフェース）

(18)　DbjXmlUploadInfoインターフェース（XML文書のアップロード情報を扱うインターフェース）

(1)　DbjACEインターフェース（ACEの値を扱うインターフェース）

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

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

メソッド | 機能
ACEの値を取得するメソッド
getPermission | パーミッションの取得
getSubject | サブジェクトの取得
getSubjectType | サブジェクト種別の取得
propSet | ACEのプロパティ値集合の取得
ACEの値を設定するメソッド
setPermission | パーミッションの設定
setPropSet | ACEのプロパティ値集合の設定
setSubject | サブジェクトの設定
setSubjectType | サブジェクト種別の設定
ACEのサブジェクト種別を設定するメソッド
setGroupSubject | サブジェクトをグループサブジェクトとして設定
setSystemSubject | サブジェクトをシステムサブジェクトとして設定
setUserSubject | サブジェクトをユーザサブジェクトとして設定

(2)　DbjCheckOutInfoインターフェース（バージョン付きオブジェクトのチェックアウト情報を扱うインターフェース）

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

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

メソッド | 機能
チェックアウト情報を取得するメソッド
getCheckOutUserId | チェックアウトしたユーザのユーザ識別子の取得
getCheckOutVersionId | 仮のバージョン識別子の取得
isCheckOut | チェックアウト中かどうかの判定

(3)　DbjContentInfoインターフェース（文書のコンテンツ情報を扱うインターフェース）

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

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

メソッド | 機能
文書のコンテンツ情報を取得するメソッド
getRenditionType | コンテンツのレンディションタイプの取得
getRetrievalName | コンテンツのファイル名の取得

(4)　DbjFetchInfoインターフェース（検索結果取得情報を扱うインターフェース）

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

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

メソッド | 機能
検索結果取得情報を取得するメソッド
getCacheKey | キャッシュキーの取得
getCacheName | キャッシュ名の取得
getCacheTotal | 検索結果キャッシュの全件数の取得
getComparator | Comparatorインターフェースの取得
getFetchCount | 検索結果の取得件数の取得
getMaxFetchCount | 検索結果の最大取得件数の取得
getStartIndex | 検索結果の取得開始位置の取得
検索結果取得情報を設定するメソッド
setCacheKey | キャッシュキーの設定
setCacheName | キャッシュ名の設定
setCacheTotal | 検索結果キャッシュの全件数の設定
setComparator | Comparatorインターフェースの設定
setFetchCount | 検索結果の取得件数の設定
setMaxFetchCount | 検索結果の最大取得件数の設定
setStartIndex | 検索結果の取得開始位置の設定

(5)　DbjMappedPropインターフェース（XMLプロパティマッピング結果情報を扱うインターフェース）

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

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

メソッド | 機能
XMLプロパティマッピング結果情報を取得するメソッド
getClassList | マッピングされたDMAクラス名のリストの取得
propSet | マッピングされたプロパティ値集合の取得

(6)　DbjPropSetインターフェース（プロパティ値集合を扱うインターフェース）

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

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

メソッド | 機能
プロパティ値を取得するメソッド
getIntegerVal | Integer型でのプロパティ値の取得
getIntVal | int型でのプロパティ値の取得
getListRef | List型でのプロパティ値の取得
getStringVal | String型でのプロパティ値の取得
getVArrayRef | VARRAY型でのプロパティ値の参照の取得
getVArrayVal | VARRAY型でのプロパティ値の取得
isNull | プロパティ値がNULL値かどうかの判定
プロパティ値を設定するメソッド
setNull | NULL値プロパティの設定
setPropRef | プロパティ値の参照の設定
setPropVal | プロパティ値の設定
プロパティ名を変更するメソッド
changePropName | プロパティ名の変更
changePropNames | プロパティ名の一括変更

(7)　DbjPublicACLIdElmインターフェース（パブリックACLのOIID文字列を扱うインターフェース）

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

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

メソッド | 機能
パブリックACLのOIID文字列を取得するメソッド
getId | パブリックACLのOIID文字列の取得
propSet | パブリックACLのOIID文字列のプロパティ値集合の取得
パブリックACLのOIID文字列を設定するメソッド
setId | パブリックACLのOIID文字列の設定
setPropSet | パブリックACLのOIID文字列のプロパティ値集合の設定

(8)　DbjQParamインターフェース

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

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

メソッド | 機能
?パラメタ値を取得するメソッド
getVal | ?パラメタ値の取得

(9)　DbjReferenceContentInfoインターフェース（リファレンスファイル文書のコンテンツ情報を扱うインターフェース）

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

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

メソッド | 機能
リファレンスファイル文書のコンテンツ情報を取得するメソッド
getContentLocation | コンテンツロケーションの取得
getReferenceType | リファレンス種別の取得

(10)　DbjReferencePathInfoインターフェース（リファレンスファイル文書のパス情報を扱うインターフェース）

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

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

メソッド | 機能
リファレンスファイル文書のパス情報を取得するメソッド
getContentOperateMode | コンテンツのパス操作モードの取得
getDeleteRootPath | 削除するディレクトリのルートパスの取得
getEntry | 登録するコンテンツのパスまたはダウンロード先のパスを取得
getTargetPath | コンテンツ格納先バスの取得
リファレンスファイル文書のパス情報を設定するメソッド
setContentOperateMode | コンテンツのパス操作モードの設定
setDeleteRootPath | 削除するディレクトリのルートパスの設定
setEntry | 登録するコンテンツのパスまたはダウンロード先のパスの設定
setTargetPath | コンテンツ格納先パスの設定

(11)　DbjReferenceUploadInfoインターフェース（リファレンスファイル文書のアップロード情報を扱うインターフェース）

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

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

メソッド | 機能
リファレンスファイル文書のアップロード情報を取得するメソッド
getReferencePathInfo | リファレンスファイル文書のパス情報の取得
リファレンスファイル文書のアップロード情報を設定するメソッド
setReferencePathInfo | リファレンスファイル文書のパス情報の設定

(12)　DbjRenditionInfoインターフェース（レンディション情報を扱うインターフェース）

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

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

メソッド | 機能
レンディションタイプを取得するメソッド
getRenditionType | レンディションタイプの取得
propSet | レンディションタイプのプロパティ値集合の取得

(13)　DbjRenditionListインターフェース（レンディション情報のリストを扱うインターフェース）

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

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

メソッド | 機能
レンディションタイプのリストを取得するメソッド
getRenditionInfo | レンディション情報の取得
getRenditionTypeList | レンディションタイプのリストの取得

(14)　DbjResultSetインターフェース（検索結果集合を扱うインターフェース）

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

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

メソッド | 機能
カーソルを操作するメソッド
absolute | カーソルの絶対指定行への移動
afterLast | カーソルの最終行の後ろへの移動
beforeFirst | カーソルの先頭行の前への移動
first | カーソルの先頭行への移動
getRow | カーソル行インデクスの取得
isAfterLast | カーソルが最終行の後ろかどうかの判定
isBeforeFirst | カーソルが先頭行の前かどうかの判定
isFirst | カーソルが先頭行かどうかの判定
isLast | カーソルが最終行かどうかの判定
last | カーソルの最終行への移動
next | カーソルの次の行への移動
previous | カーソルの前の行への移動
検索結果集合のメタ情報を扱うメソッド
findColumnName | 列インデクスの取得
getColumnMetaName | 列名の取得（表名を含む）
getColumnName | 列名の取得
getColumnType | 列のデータ型の取得
getTableName | 表名の取得
isNamed | 名前付き検索結果かどうかの判定
setColumnMetaName | 列名の設定
検索結果集合のサイズを扱うメソッド
getColumnCount | 列数の取得
getRowCount | 行数の取得
指定した行または列のデータを取得するメソッド
getColumnVals | 列データの取得
getIntegerVal | Integer型での列データの取得
getIntVal | int型での列データの取得
getObjectRef | データの参照の取得
getObjectVal | データの取得
getPropSet | 行データをプロパティ値集合として取得
getRowVals | 行データの取得
getStringVal | String型での列データの取得
getVArrayRef | VARRAY型でのデータの参照の取得
getVArrayVal | VARRAY型でのデータの取得
isNull | NULL値かどうかの判定
列を削除するメソッド
distinct | 列の重複の排除
reduct | 名前なし列の削除

(15)　DbjSetLinkInfoインターフェース（リンクの設定情報を扱うインターフェース）

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

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

メソッド | 機能
リンク設定情報を取得するメソッド
getLinkType | リンク種別の取得
getTargetObj | リンク先オブジェクトの取得
propSet | リンクオブジェクトのプロパティ値集合の取得
リンク設定情報を設定するメソッド
setPropSet | リンクオブジェクトのプロパティ値集合の設定
setTargetObj | リンク先オブジェクトの設定

(16)　DbjUploadInfoインターフェース（文書のアップロード情報を扱うインターフェース）

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

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

メソッド | 機能
文書のアップロード情報を取得するメソッド
getFilePath | 登録する文書のフルパスの取得
getIndexPath | 全文検索インデクス作成用ファイルのフルパスの取得
getRenditionType | 登録する文書のレンディションタイプの取得
getRetrievalName | 登録する文書のファイル名の取得
renditionPropSet | レンディションプロパティ値集合の取得
文書のアップロード情報を設定するメソッド
setFilePath | 登録する文書のフルパスの設定
setIndexPath | 全文検索インデクス作成用ファイルのフルパスの設定
setRenditionPropSet | レンディションプロパティ値集合の設定
setRenditionType | 登録する文書のレンディションタイプの設定
setRetrievalName | 登録する文書のファイル名の設定

(17)　DbjVArrayインターフェース（可変長配列オブジェクトを扱うインターフェース）

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

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

メソッド | 機能
可変長配列オブジェクトのデータを取得するメソッド
getPropCount | メタプロパティ数の取得
getPropNameSet | メタプロパティの取得
getPropVals | 可変長配列オブジェクトのプロパティ値のリストの取得
propSet | プロパティ値集合の取得
可変長配列オブジェクトのデータを設定するメソッド
addPropSet | プロパティ値集合（行）の追加
addPropVals | プロパティ値（列）の追加
removeProp | プロパティの削除
可変長配列オブジェクトのプロパティ名を変更するメソッド
changePropName | 可変長配列オブジェクトのプロパティ名の変更
changePropNames | 可変長配列オブジェクトのプロパティ名の一括変更

(18)　DbjXmlUploadInfoインターフェース（XML文書のアップロード情報を扱うインターフェース）

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

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

メソッド | 機能
XML文書のアップロード情報を取得するメソッド
getFilterFilePath | フィルタリング定義ファイルのフルパスの取得
getIndexType | 全文検索インデクスの種別の取得
getMappingId | マッピング定義名の取得
getParseLevel | 構文解析レベルの取得
XML文書のアップロード情報を設定するメソッド
setFilterFilePath | フィルタリング定義ファイルのフルパスの設定
setIndexType | 全文検索インデクスの種別の設定
setMappingId | マッピング定義名の設定
setParseLevel | 構文解析レベルの設定
XML文書の構文解析結果メッセージを扱うメソッド
clearParseMessage | 構文解析結果メッセージのクリア
getParseMessage | 構文解析結果メッセージの取得

1.3　文書管理クラスのインターフェース，およびメソッド一覧

文書管理クラスのインターフェース，およびメソッドを一覧形式で説明します。

＜この節の構成＞

1.3.1　文書管理クラスのインターフェース一覧

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

1.3.1　文書管理クラスのインターフェース一覧

文書管理クラスのインターフェースの一覧を表1-23に示します。なお，それぞれのインターフェースの使用方法については，表の参照先欄に示す個所（マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の章・節番号と標題）を参照してください。

表1-23　文書管理クラスのインターフェース一覧

インターフェース | 説明 | 参照先
文書管理セッションを扱うインターフェース
DbjSessionインターフェース | Java クラスライブラリのセッションを管理するインターフェース | 6.6　セッションとトランザクションの制御
文書空間操作を扱うインターフェース
DbjDocSpaceインターフェース | 文書空間へのアクセスを扱うインターフェース | 6.7　文書空間へのアクセス
文書空間オブジェクト操作を扱うインターフェース
DbjObjインターフェース | 一つの文書空間オブジェクトへのアクセスを扱うインターフェース | 6.8　文書空間オブジェクトの操作
DbjVerObjインターフェース | 一つの文書空間オブジェクトにアクセスするインターフェースに加えて，バージョンオブジェクトのバージョン識別子を扱うインターフェース | 6.8　文書空間オブジェクトの操作
複数の文書空間オブジェクト操作を扱うインターフェース
DbjObjListインターフェース | 複数の文書空間オブジェクトに一括してアクセスするインターフェース | 6.8　文書空間オブジェクトの操作
DbjVerObjListインターフェース | 複数の文書空間オブジェクトに一括してアクセスするインターフェースに加えて，リストの要素すべてのバージョン識別子を扱うインターフェース | 6.8　文書空間オブジェクトの操作
リンクオブジェクト操作を扱うインターフェース
DbjLinkObjインターフェース | 一つのリンクオブジェクトにアクセスするインターフェース | 6.8　文書空間オブジェクトの操作
複数のリンクオブジェクト操作を扱うインターフェース
DbjLinkObjListインターフェース | 複数のリンクオブジェクトに一括してアクセスするインターフェース | 6.8　文書空間オブジェクトの操作
XML文書プロパティマッピングを扱うインターフェース
DbjXmlTranslatorインターフェース | XML文書のプロパティマッピングを扱うインターフェース | 6.10　XML文書を管理するための操作

Java クラスライブラリで提供しているこれらのインターフェースには継承関係があり，上位にあるインターフェースで定義したメソッドは，下位のインターフェースに継承されます。インターフェースの継承関係を図1-2に示します。

図1-2　文書管理クラスのインターフェースの継承関係

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プロパティマッピング結果情報の作成

1.4　メタクラスのインターフェース，およびメソッド一覧

メタクラスのインターフェース，およびメソッドを一覧形式で説明します。

＜この節の構成＞

1.4.1　メタクラスのインターフェース一覧

1.4.2　メタクラスのメソッド一覧

1.4.1　メタクラスのインターフェース一覧

メタクラスのインターフェースの一覧を表1-33に示します。なお，それぞれのインターフェースの使用方法については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「6.11　メタ情報の取得」を参照してください。

表1-33　メタクラスのインターフェース一覧

インターフェース | 説明
DbjClassDescインターフェース | 一つのクラスのクラスディスクリプションを扱うインターフェース
DbjMetaインターフェース | 一つの文書空間のメタ情報を扱うインターフェース
DbjMetaManagerインターフェース | 文書空間のメタ情報を管理するインターフェース
DbjPropDescインターフェース | 一つのプロパティのプロパティディスクリプションを扱うインターフェース

なお，Java クラスライブラリで提供しているメタクラスのインターフェースには，継承関係がありません。

1.4.2　メタクラスのメソッド一覧

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

＜この項の構成＞

(1)　DbjClassDescインターフェース（クラスディスクリプションを扱うインターフェース）

(2)　DbjMetaインターフェース（文書空間のメタ情報を扱うインターフェース）

(3)　DbjMetaManagerインターフェース（文書空間のメタ情報を管理するインターフェース）

(4)　DbjPropDescインターフェース（プロパティディスクリプションを扱うインターフェース）

(1)　DbjClassDescインターフェース（クラスディスクリプションを扱うインターフェース）

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

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

メソッド | 機能
getName | クラス名の取得
getProperties | プロパティディスクリプションの取得
getSubClasses | サブクラスのクラスディスクリプションの取得
getSuperClass | スーパークラスのクラスディスクリプションの取得

(2)　DbjMetaインターフェース（文書空間のメタ情報を扱うインターフェース）

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

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

メソッド | 機能
getClassDesc | 指定したクラスのクラスディスクリプションの取得
getDocSpaceId | 文書空間識別子の取得
getExtFromRenditionType | レンディションタイプに対応する拡張子の取得
getPropDataType | 指定したプロパティのデータ型の取得
getPropDesc | 指定したプロパティのプロパティディスクリプションの取得
getRenditionType | 拡張子に対応するレンディションタイプの取得

(3)　DbjMetaManagerインターフェース（文書空間のメタ情報を管理するインターフェース）

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

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

メソッド | 機能
getMeta | メタ情報の取得

(4)　DbjPropDescインターフェース（プロパティディスクリプションを扱うインターフェース）

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

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

メソッド | 機能
getDataType | プロパティのデータ型の取得
getName | プロパティ名の取得
getVArrayClass | VARRAY型プロパティを扱うクラスのクラスディスクリプションの取得

1.5　例外クラスのクラス一覧，スーパークラス，およびコンストラクタ

例外クラスのクラスの一覧，スーパークラス，およびコンストラクタについて説明します。

＜この節の構成＞

1.5.1　例外クラスのクラス一覧

1.5.2　例外クラスのスーパークラス

1.5.3　例外クラスのコンストラクタ

1.5.1　例外クラスのクラス一覧

例外クラスのクラス一覧を表1-38に示します。なお，例外処理の方法については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「6.12　例外処理」を参照してください。

表1-38　例外クラスのクラス一覧

クラス | 説明
DbjAccessControlExceptionクラス | ユーザがメソッドを実行する際にその操作に対してアクセス権がなかった場合のエラーを表す例外クラス
DbjAccessControlNotSupportedExceptionクラス | 文書空間がアクセス制御機能対応していない場合のエラーを表す例外クラス
DbjACEOperationExceptionクラス | ACEの操作エラーを表すスーパークラス。特定のACE操作のエラーはサブクラスがスローされる例外クラス
DbjACLOutOfRangeExceptionクラス | 文書空間オブジェクトのACEの個数が制限値を超えた場合のエラーを表す例外クラス
DbjAlreadyCheckOutExceptionクラス | すでにチェックアウトされている場合のエラーを表す例外クラス
DbjCheckOutExceptionクラス | チェックアウトについてのエラーを表す例外クラスのスーパークラス
DbjContentNotRegisteredExceptionクラス | リファレンスファイル管理機能を使用したオブジェクトをローカルファイルにダウンロードする場合に，オブジェクトにコンテンツが登録されていないときのエラーを表す例外クラス
DbjContentTypeMismatchExceptionクラス | リファレンスファイル管理機能で，オブジェクトのコンテンツ種別とメソッドが要求するコンテンツ種別が一致しない場合のエラーを表す例外クラス
DbjCORBAExceptionクラス | CORBAエラー（TPBrokerでのエラー）を表す例外クラス
DbjDBDeadLockExceptionクラス | DBのデッドロックエラーを表す例外クラス
DbjDBExceptionクラス | DBエラーを表す例外クラス
DbjDBLockTimeoutExceptionクラス | DBのロックタイムアウトエラーを表す例外クラス
DbjDisconnectedSessionExceptionクラス | 文書空間との接続が切断された場合のエラーを表す例外クラス
DbjErrorクラス | java.lang.Errorクラスを継承し，Java クラスライブラリ固有の致命的エラーを表す例外クラスのスーパークラス
DbjExceptionクラス | java.lang.Exceptionクラスを継承し，Java クラスライブラリ固有のエラーを表す例外クラスのスーパークラス
DbjFileAccessExceptionクラス | ファイルのアクセス権がない場合のエラーを表す例外クラス
DbjFileNotFoundExceptionクラス | 指定ファイルが存在しない場合のエラーを表す例外クラス
DbjFileReferenceCurrentContentNotfoundExceptionクラス | リファレンスファイル管理機能を使用したバージョン付き文書オブジェクトで，カレントバージョンにコンテンツが存在しない場合のエラーを表す例外クラス
DbjFileReferenceMismatchStatusExceptionクラス | リファレンスファイル管理機能を使用するサーバでのコンテンツ操作でエラーが発生し，オブジェクトとコンテンツが不整合な状態になった場合のエラーを表す例外クラス
DbjFileReferenceOperationFailedExceptionクラス | リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合のエラーを表す例外クラス
DbjIllegalDocSpaceIdExceptionクラス | 不正な文書空間識別子が指定された場合のエラーを表す例外クラス
DbjIllegalObjectTypeExceptionクラス | メソッドによる操作に不適切な文書空間オブジェクトの種別が指定された場合のエラーを表す例外クラス
DbjIllegalPropValExceptionクラス | 指定プロパティ値の不正エラーを表す例外クラス
DbjInitializeErrorクラス | Java クラスライブラリ初期化時のエラーを表す例外クラス
DbjInternalErrorクラス | Java クラスライブラリの内部エラーを表す例外クラス
DbjIOExceptionクラス | Java クラスライブラリのIOエラーを表す例外クラスのスーパークラス
DbjIsMasterRenditionExceptionクラス | マスタレンディションが指定された場合のエラーを表す例外クラス
DbjLastVersionExceptionクラス | 操作対象となるバージョン付きオブジェクトの最後の一つのバージョンを削除しようとした場合のエラーを表す例外クラス
DbjMasterRenditionNotSetExceptionクラス | マスタレンディションのレンディションタイプが設定されていない場合のエラーを表す例外クラス
DbjNotAuthenticatedExceptionクラス | ユーザ認証エラーを表す例外クラス
DbjNotCheckOutExceptionクラス | チェックアウトされていない場合のエラーを表す例外クラス
DbjNotLoginExceptionクラス | 文書空間と接続（ログイン）されていない場合のエラーを表す例外クラス
DbjObjectNotFoundExceptionクラス | 操作対象となる文書空間オブジェクトが，メソッド実行時にすでに削除されていた場合，または存在しない場合のエラーを表す例外クラス
DbjOutOfMemoryErrorクラス | メモリ不足が発生したことを表す例外クラス
DbjPublicACLAlreadyBoundExceptionクラス | 指定したパブリックACLがすでにバインドされている場合のエラーを表す例外クラス
DbjPublicACLNotBoundExceptionクラス | 指定したパブリックACLがバインドされていない場合のエラーを表す例外クラス
DbjPublicACLNotFoundExceptionクラス | 指定したパブリックACLが存在しない場合のエラーを表す例外クラス
DbjPublicACLOperationExceptionクラス | パブリックACLの操作エラーを表すスーパークラス。特定のパブリックACL操作のエラーにはサブクラスがスローされる例外クラス
DbjPublicACLOutOfRangeExceptionクラス | オブジェクトに追加できるパブリックACLの数が制限値を超えた場合のエラーを表す例外クラス
DbjReferenceTypeMismatchExceptionクラス | リファレンスファイル管理機能で，オブジェクトのリファレンス種別とメソッドが要求するリファレンス種別が一致しない場合のエラーを表す例外クラス
DbjRenditionCountOutOfRangeExceptionクラス | レンディション数が制限値を超えた場合のエラーを表す例外クラス
DbjRenditionIsEmptyExceptionクラス | レンディションが空の場合のエラーを表す例外クラス
DbjRenditionNotConvertedExceptionクラス | レンディションが更新処理されていない場合のエラーを表す例外クラス
DbjRenditionNotFoundExceptionクラス | 指定レンディションが存在しない場合のエラーを表す例外クラス
DbjRenditionTypeDuplicatedExceptionクラス | レンディションタイプが重複している場合のエラーを表す例外クラス
DbjSessionExceptionクラス | セッションについてのエラーを表す例外クラスのスーパークラス
DbjSessionNotConnectExceptionクラス | 文書空間との接続が行われていない場合のエラーを表す例外クラスのスーパークラス
DbjSessionOverflowExceptionクラス | 文書空間同時接続数が制限値を超えた場合のエラーを表す例外クラス
DbjSubjectLengthOutOfRangeExceptionクラス | ACEのサブジェクト長が制限値を超えた場合のエラーを表す例外クラス
DbjTargetContentPathNotSetExceptionクラス | リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていない場合のエラーを表す例外クラス
DbjUnknownErrorクラス | Java クラスライブラリ内での未知のエラーの発生を表す例外クラス
DbjXmlParseExceptionクラス | XML文書の構文解析エラーを表す例外クラス

Java クラスライブラリで提供しているこれらのクラスには継承関係があり，上位にあるクラスで定義したメソッドは，下位のクラスに継承されます。クラスの継承関係を図1-3に示します。

図1-3　例外クラスのインターフェースの継承関係

1.5.2　例外クラスのスーパークラス

Java クラスライブラリの例外クラスのスーパークラスについて次に説明します。

＜この項の構成＞

(1)　DbjErrorクラス

(2)　DbjExceptionクラス

(1)　DbjErrorクラス

DbjErrorクラスはjava.lang.Errorクラスを継承し，Java クラスライブラリ固有の致命的なエラーを表すスーパークラスです。メモリ不足，Java クラスライブラリの初期化エラー，Java クラスライブラリ内で予期しない内部エラーが発生した時のエラーなど，ユーザアプリケーションプログラムで対処できないエラーを表します。

(2)　DbjExceptionクラス

DbjExceptionクラスはjava.lang.Exceptionクラスを継承し，Java クラスライブラリ固有のエラーを表すスーパークラスです。

1.5.3　例外クラスのコンストラクタ

DbjErrorクラスおよびDbjExceptionクラスは，二つのpublic属性のコンストラクタを保持します。一つは，引数を取らないコンストラクタで，もう一つは，String型の引数を取るコンストラクタです。引数を取らないコンストラクタは，エラーメッセージにnullが関連付けられた例外クラスのオブジェクトを生成します。また，String型の引数を取るコンストラクタは，引数に指定されたエラーメッセージが関連付けられた例外クラスのオブジェクトを生成します。

1.6　定数定義クラスのカテゴリ一覧

定数定義クラスのカテゴリを表1-39に示します。

表1-39　定数定義クラスのカテゴリ一覧

カテゴリ | 説明
DbjDefクラス
ACL | 検索実行時のアクセス制御モードを表す定数
DATATYPE | プロパティのデータ型を表す定数
DMA BOOLEAN | BOOL型を表す定数
INDEXTYPE | 全文検索インデクスの種別を表す定数
LINK | リンク種別を表す定数
LOCK | ロック種別を表す定数
OBJTYPE | オブジェクト種別を表す定数
OPERATEMODE | コンテンツのパス操作モードを表す定数
ORDER | バージョン情報の取得順序を表す定数
PERM | パーミッションを表す定数
PRIV | ユーザの特権を表す定数
REFERENCETYPE | リファレンス種別を表す定数
RELATIONEND | 文書間リンク設定情報一覧の取得条件を表す定数
RENDSTATUS | レンディションステータスを表す定数
SUBJECTTYPE | サブジェクト種別を表す定数
SYSSUBJECT | システムサブジェクトを表す定数
XMLPARSE | XML文書の構文解析レベルを表す定数
Others | そのほか（上記以外）の内容を表す定数
DbjTraceDefクラス
TRACELEVEL | トレースの出力レベルを表す定数
TRACEOUTPUT | トレースの出力先を表す定数

1.7　ライブラリ情報取得クラスのクラス，およびメソッド一覧

ライブラリ情報取得クラスのクラス，およびメソッドを一覧形式で説明します。

＜この節の構成＞

1.7.1　ライブラリ情報取得クラスのクラス

1.7.2　ライブラリ情報取得クラスのメソッド一覧

1.7.1　ライブラリ情報取得クラスのクラス

ライブラリ情報取得クラスのクラスを表1-40に示します。なお，クラスの使用方法については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「6.13　ライブラリ情報の取得」を参照してください。

表1-40　ライブラリ情報取得クラスのクラス

クラス | 説明
ライブラリ情報を扱うクラス
DbjLibInfoクラス | DocumentBroker Development KitおよびDocumentBroker Runtimeのバージョン情報を扱うクラス

1.7.2　ライブラリ情報取得クラスのメソッド一覧

ライブラリ情報取得クラスのDbjLibInfoクラス（DocumentBroker Development KitおよびDocumentBroker Runtimeのバージョン情報を扱うクラス）のメソッドを表1-41に示します。

表1-41　DbjLibInfoクラスのメソッド

メソッド | 機能
バージョンを取得するメソッド
getVersion | DocumentBroker Development KitおよびDocumentBroker Runtimeのバージョンの取得

1.8　トレースクラスのクラス，およびメソッド一覧

トレースクラスのクラス，およびメソッドを一覧形式で説明します。

＜この節の構成＞

1.8.1　トレースクラスのクラス

1.8.2　トレースクラスのメソッド一覧

1.8.1　トレースクラスのクラス

トレースクラスのクラスを表1-42に示します。なお，クラスの使用方法については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「6.14　ユーザアプリケーションプログラムのトレース情報の出力」を参照してください。

表1-42　トレースクラスのクラス

クラス | 説明
トレース情報を扱うクラス
DbjTraceクラス | トレース情報を扱うクラス

1.8.2　トレースクラスのメソッド一覧

トレースクラスのDbjTraceクラス（トレース情報を扱うクラス）のメソッドを表1-43に示します。

表1-43　DbjTraceクラスのメソッド

メソッド | 機能
トレース情報を出力するメソッド
arg | パラメタ情報の出力
call | 外部APIの呼び出し情報の出力
DbjTrace | コンストラクタ
enter | メソッドの入口情報の出力
error | エラー情報の出力
exit | メソッドの出口情報の出力
hint | 下位のメソッドのエラー情報の出力
init | トレースクラスの初期化
msg | メッセージの出力
returned | 外部APIからのリターン情報の出力

1.9　クラス，インターフェースおよびメソッドの説明形式

Java クラスライブラリのクラス，インターフェースおよびメソッドについての説明形式について示します。各クラスまたは各インターフェースの説明では，そのクラスまたはインターフェースに定義されるメソッドについてだけ説明しています。上位のクラスまたはインターフェースで定義されているメソッドについては，定義元のクラスまたはインターフェースを参照してください。

＜この節の構成＞

1.9.1　メソッドで説明する項目

1.9.2　パラメタクラスのインターフェースで説明する項目

1.9.3　文書空間オブジェクトのプロパティのデータ型

1.9.1　メソッドで説明する項目

クラスおよびインターフェースの説明に続けて，そのクラスおよびインターフェースのメソッドを説明しています。上位のインターフェースから継承されるメソッドの詳細については，継承元のインターフェースのメソッドの説明を参照してください。

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メソッドの機能の詳細を説明しています。

(2)　形式

メソッドの形式を説明しています。複数の形式がある場合，「(a)　形式1」，「(b)　形式2」，「(c)　形式3」などと表記します。

(3)　引数

引数について次のように説明しています。

引数（入力）

指定する値について説明しています。

引数（入出力）

指定した領域に設定される値について説明しています。

引数は「形式」で記述した文字列です。

省略できることを明記していない引数は，すべて指定する必要があります。

（入力）は，値を指定することを示しています。

（入出力）は，メソッドによって出力値が設定されるオブジェクトを指定することを示しています。

(4)　戻り値

メソッドの戻り値を説明しています。戻り値を返却しないメソッドでは，「なし」と記述します。

(5)　例外

発生する例外について説明しています。

1.9.2　パラメタクラスのインターフェースで説明する項目

パラメタクラスのインターフェースの説明では，次の項目について説明しています。

＜この項の構成＞

(1)　直接のスーパーインターフェース

(2)　プロパティ一覧

(1)　直接のスーパーインターフェース

該当するインターフェースの，直接のスーパーインターフェース名を記述しています。

なお，パラメタクラスのインターフェースは，java.util.Collectionインターフェース，java.util.Listインターフェース，java.util.Mapインターフェース，およびjava.lang.Cloneableインターフェースなどを継承しています。

(2)　プロパティ一覧

クラスおよびインターフェースで定義されているプロパティ一覧を記述しています。プロパティ一覧の例を表1-44に示します。

表1-44　プロパティ一覧の例

プロパティ名 | データ型 | getterメソッド | setterメソッド
aaa | xxx型 | getAaa | setAaa
bbb | yyy型 | getBbb | setBbb

プロパティ名

プロパティの名称を記述しています。

データ型

プロパティの値のデータ型を記述しています。インターフェースを扱う場合は，インターフェース名を記述しています。

getterメソッド

プロパティを取得するメソッド名を記述しています。

setterメソッド

プロパティを設定するメソッド名を記述しています。

1.9.3　文書空間オブジェクトのプロパティのデータ型

メソッドの説明で使用する文書空間オブジェクトのプロパティのデータ型と，DocumentBrokerサーバで扱うデータ型の対応を表1-45に示します。

表1-45　文書空間オブジェクトのプロパティのデータ型とDocumentBrokerサーバで扱うデータ型の対応

プロパティのデータ型 | DocumentBrokerサーバで扱うデータ型
BOOL | Boolean型
INT | Integer32型
VARRAY | Object型
STR | String型
STRLIST | －

（凡例）

－：該当するデータ型がないことを示します。

DocumentBrokerサーバで扱うデータ型については，マニュアル「DocumentBroker Version 3　システム導入・運用ガイド」を参照してください。

2.　ファクトリクラス詳細

この章では，ファクトリクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

2.1　DbjFactory0200クラス

2.2　DbjFactoryインターフェース

2.1　DbjFactory0200クラス

DbjFactory0200クラスは，Java クラスライブラリのファクトリインターフェース，およびメタマネージャーインターフェースを取得するクラスです。なお，このクラスはインスタンスを生成できません（コンストラクタは，private属性です）。

Java クラスライブラリは，このクラスのメソッドが実行される初回時に初期化されます。初期化によって，Java クラスライブラリは動作環境の定義に従った内容で設定されます。ただし，初期化の実行時にエラーがあると，例外クラスDbjInitializeErrorがスローされるおそれがあります。

以降，DbjFactory0200クラスのメソッドについて説明します。

＜この節の構成＞

2.1.1　getFactory（ファクトリインターフェースの取得）

2.1.2　getMetaManager（メタマネージャーインターフェースの取得）

2.1.1　getFactory（ファクトリインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ファクトリインターフェースを取得します。

(2)　形式

static DbjFactory getFactory()

(3)　引数

なし

(4)　戻り値

ファクトリインターフェース（DbjFactoryインターフェース）

(5)　例外

なし

2.1.2　getMetaManager（メタマネージャーインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メタマネージャーインターフェースを取得します。

(2)　形式

static DbjMetaManager getMetaManager()

(3)　引数

なし

(4)　戻り値

メタマネージャーインターフェース（DbjMetaManagerインターフェース）

(5)　例外

なし

2.2　DbjFactoryインターフェース

DbjFactoryインターフェースは，Java クラスライブラリのオブジェクトを生成して，そのインターフェースを取得する機能を持つファクトリインターフェースです。DbjFactoryインターフェースは，表2-1に示すオブジェクトを作成してインターフェースを取得するメソッドを提供します。ユーザアプリケーションプログラムは，DbjFactoryインターフェースを使用してJava クラスライブラリのセッションオブジェクトを生成して，そのインターフェースを取得したり，パラメタクラスのオブジェクトを生成して，そのインターフェースを取得したりできます。

DbjFactoryインターフェースで作成できるオブジェクト，そのオブジェクトを作成するメソッド，および取得するインターフェース名を表2-1に示します。

表2-1　DbjFactoryインターフェースで作成できるオブジェクト，オブジェクトを作成するメソッド，および取得するインターフェース

オブジェクト | オブジェクトを作成するメソッド | 取得するインターフェース
?パラメタ（BOOL型）オブジェクト | createBooleanQParam | DbjBooleanQParam
?パラメタ（INT型）オブジェクト | createInteger32QParam | DbjInteger32QParam
?パラメタ（Object型）オブジェクト | createObjQParam | DbjObjQParam
?パラメタ（OIID）オブジェクト | createOIIDQParam | DbjOIIDQParam
?パラメタ（String型）オブジェクト | createStringQParam | DbjStringQParam
?パラメタ（概念検索種文章）オブジェクト | createSeedDocQParam | DbjSeedDocQParam
ACEオブジェクト | createACE | DbjACE
XMLトランスレーターオブジェクト | createXmlTranslator | DbjXmlTranslator
XML文書アップロード情報オブジェクト | createXmlUploadInfo | DbjXmlUploadInfo
アップロード情報オブジェクト | createUploadInfo | DbjUploadInfo
可変長配列オブジェクト | createVArray | DbjVArray
Java クラスライブラリのセッションオブジェクト | createSession | DbjSession
検索結果取得情報オブジェクト | createFetchInfo | DbjFetchInfo
構成管理モードがFIXモードの構成管理型リンク設定情報オブジェクト | createSetVTFixLinkInfo | DbjSetVTFixLinkInfo
構成管理モードがFLOATINGモードの構成管理型リンク設定情報オブジェクト | createSetVTFloatLinkInfo | DbjSetVTFloatLinkInfo
参照型リンク設定情報オブジェクト | createSetRCRLinkInfo | DbjSetRCRLinkInfo
直接型リンク設定情報オブジェクト | createSetDCRLinkInfo | DbjSetDCRLinkInfo
パブリックACLのOIIDエレメントオブジェクト | createPublicACLIdElm | DbjPublicACLIdElm
プロパティ値集合オブジェクト | createPropSet | DbjPropSet
文書間リンク設定情報オブジェクト | createSetRelLinkInfo | DbjSetRelLinkInfo
リファレンスファイル文書のアップロード情報オブジェクト | createReferenceUploadInfo | DbjReferenceUploadInfo
リファレンスファイル文書のパス情報オブジェクト | createReferencePathInfo | DbjReferencePathInfo

以降，DbjFactoryインターフェースのメソッドについて説明します。

＜この節の構成＞

2.2.1　createACE（ACEの作成）

2.2.2　createBooleanQParam（BOOL型の?パラメタの作成）

2.2.3　createFetchInfo（検索結果取得情報オブジェクトの作成）

2.2.4　createInteger32QParam（INT型の?パラメタの作成）

2.2.5　createOIIDQParam（OIIDの?パラメタの作成）

2.2.6　createObjQParam（Object型の?パラメタの作成）

2.2.7　createPropSet（プロパティ値集合オブジェクトの作成）

2.2.8　createPublicACLIdElm（パブリックACLのOIIDエレメントの作成）

2.2.9　createReferencePathInfo（リファレンスファイル文書のパス情報オブジェクトの作成）

2.2.10　createReferenceUploadInfo（リファレンスファイル文書のアップロード情報オブジェクトの作成）

2.2.11　createSeedDocQParam（種文章の?パラメタの作成）

2.2.12　createSession（Java クラスライブラリのセッションオブジェクトの作成）

2.2.13　createSetDCRLinkInfo（直接型リンク設定情報の作成）

2.2.14　createSetRCRLinkInfo（参照型リンク設定情報の作成）

2.2.15　createSetRelLinkInfo（文書間リンク設定情報の作成）

2.2.16　createSetVTFixLinkInfo（構成管理モードがFIXモードの構成管理型リンク設定情報の作成）

2.2.17　createSetVTFloatLinkInfo（構成管理モードがFLOATINGモードの構成管理型リンク設定情報の作成）

2.2.18　createStringQParam（String型の?パラメタの作成）

2.2.19　createUploadInfo（文書のアップロード情報オブジェクトの作成）

2.2.20　createVArray（可変長配列オブジェクトの作成）

2.2.21　createXmlTranslator（XMLトランスレーターの取得）

2.2.22　createXmlUploadInfo（XML文書のアップロード情報オブジェクトの作成）

2.2.1　createACE（ACEの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEを作成し，そのインターフェース（DbjACEインターフェース）を取得します。

形式１では，初期値状態のACEを作成します。形式２では，指定されたプロパティ値集合をACEとみなして作成してpropSetプロパティに設定します。この場合，値はコピーされません。形式３では，指定された引数を初期値としてACEを作成します。なお，形式2および形式3の引数に指定するプロパティ値集合の妥当性は，検証されません。

(2)　形式

(a)　形式1

DbjACE createACE()

(b)　形式2

DbjACE createACE(
    DbjPropSet  src
)

(c)　形式3

DbjACE createACE(
    String      subject,
    int         subjectType,
    int         permission
)

(3)　引数

src（入力）

ACEとして扱うプロパティ値集合を指定します。nullを指定すると例外がスローされます。

subject（入力）

ACEのサブジェクトを指定します。

subjectType（入力）

ACEのサブジェクト種別を指定します。

permission（入力）

ACEのパーミッションを指定します。

(4)　戻り値

ACEインターフェース（DbjACEインターフェース）

(5)　例外

NullPointerException

引数srcにnullを指定した場合

2.2.2　createBooleanQParam（BOOL型の?パラメタの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

BOOL型の?パラメタを作成し，そのインターフェース（DbjBooleanQParamインターフェース）を取得します。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjBooleanQParam createBooleanQParam(
    int     param
)

(3)　引数

param（入力）

パラメタの値を指定します。次に示す値のどれかを指定できます。

DbjDef.DMA_TRUE

DbjDef.DMA_FALSE

DbjDef.DMA_UNKNOWN

(4)　戻り値

BOOL型の?パラメタインターフェース（DbjBooleanQParamインターフェース）

(5)　例外

なし

2.2.3　createFetchInfo（検索結果取得情報オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果取得情報オブジェクトを作成し，そのインターフェース（DbjFetchInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，初期値を引数で指定できます。形式3では，形式２で指定できる初期値に加えて，キャッシュ検索実行時に取得した結果のソートを制御するための引数compを指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.5　DbjFetchInfoインターフェース」を参照してください。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

(a)　形式1

DbjFetchInfo createFetchInfo()

(b)　形式2

DbjFetchInfo createFetchInfo(
    int               startIndex,
    int               fetchCount,
    int               maxFetchCount,
    String            cacheName,
    int               cacheKey
)

(c)　形式3

DbjFetchInfo createFetchInfo(
    int               startIndex,
    int               fetchCount,
    int               maxFetchCount,
    Comparator        comp,
    String            cacheName,
    int               cacheKey
)

(3)　引数

startIndex（入力）

startIndexプロパティの初期値を指定します。

fetchCount（入力）

fetchCountプロパティの初期値を指定します。

maxFetchCount（入力）

maxFetchCountプロパティの初期値を指定します。

comp（入力）

comparatorプロパティの初期値を指定します。

cacheName（入力）

cacheNameプロパティの初期値を指定します。

cacheKey（入力）

cacheKeyプロパティの初期値を指定します。

(4)　戻り値

検索結果取得情報インターフェース（DbjFetchInfoインターフェース）

(5)　例外

なし

2.2.4　createInteger32QParam（INT型の?パラメタの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

INT型の?パラメタを作成し，そのインターフェース（DbjInteger32QParamインターフェース）を取得します。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjInteger32QParam createInteger32QParam(
    int       param
)

(3)　引数

param（入力）

パラメタの値を指定します。

(4)　戻り値

INT型の?パラメタインターフェース（DbjInteger32QParamインターフェース）

(5)　例外

なし

2.2.5　createOIIDQParam（OIIDの?パラメタの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

OIIDの?パラメタを作成し，そのインターフェース（DbjOIIDQParamインターフェース）を取得します。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjOIIDQParam createOIIDQParam(
    DbjObj     param
)

(3)　引数

param（入力）

パラメタの値を指定します。param.getOiid()の値が，？パラメタとして指定されます。

(4)　戻り値

OIIDの?パラメタインターフェース（DbjOIIDQParamインターフェース）

(5)　例外

なし

2.2.6　createObjQParam（Object型の?パラメタの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Object型の?パラメタを作成し，そのインターフェース（DbjObjQParamインターフェース）を取得します。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjObjQParam createObjQParam(
    DbjObj     param
)

(3)　引数

param（入力）

パラメタの値を指定します。

(4)　戻り値

Object型の?パラメタインターフェース（DbjObjQParamインターフェース）

(5)　例外

なし

2.2.7　createPropSet（プロパティ値集合オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

プロパティ値集合オブジェクトを作成し，そのインターフェース（DbjPropSetインターフェース）を取得します。

形式１では，空のプロパティ値集合オブジェクトを作成します。形式２では，指定されたマップをプロパティ値集合オブジェクトにマッピングしてDbjPropSetインターフェースを取得します。

(2)　形式

(a)　形式1

DbjPropSet createPropSet()

(b)　形式2

DbjPropSet createPropSet(
    Map      src
)

(3)　引数

src（入力)

マッピングの元になるマップを指定します。要素キーにプロパティ名，要素の値にプロパティ値を設定しておきます。nullを指定すると，要素数0の空のオブジェクトが仮定されます。

(4)　戻り値

プロパティ値集合インターフェース（DbjPropSetインターフェース）

(5)　例外

なし

2.2.8　createPublicACLIdElm（パブリックACLのOIIDエレメントの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

パブリックACLのOIIDエレメントを作成し，そのインターフェース（DbjPublicACLIdElmインターフェース）を取得します。

形式１では，初期値状態のパブリックACLのOIIDエレメントを作成します。形式２では，指定されたプロパティ値集合をパブリックACLのOIIDエレメントとみなして取得してpropSetプロパティに設定します（値はコピーされません）。形式３では，初期値に指定されたパブリックACLのOIIDを取得します。なお，形式2および形式3の引数に指定するプロパティ値集合の妥当性は検証されません。

(2)　形式

(a)　形式1

DbjPublicACLIdElm createPublicACLIdElm()

(b)　形式2

DbjPublicACLIdElm createPublicACLIdElm(
    DbjPropSet      src
)

(c)　形式3

DbjPublicACLIdElm createPublicACLIdElm(
    String          publicACLId
)

(3)　引数

src（入力）

パブリックACLのOIIDエレメントとして扱うプロパティ値集合を指定します。nullを指定した場合は，例外がスローされます。

publicACLId（入力）

パブリックACLのOIIDを指定します。nullを指定した場合は，例外がスローされます。

(4)　戻り値

パブリックACLのOIIDエレメントインターフェース（DbjPublicACLIdElmインターフェース）

(5)　例外

NullPointerException

引数srcにnullを指定した場合

2.2.9　createReferencePathInfo（リファレンスファイル文書のパス情報オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル文書のパス情報オブジェクトを作成し，そのインターフェース（DbjReferencePathInfoインターフェース）を取得します。

形式1では，オブジェクトのメンバにデフォルト値が入ります。形式2では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.14　DbjReferencePathInfoインターフェース」を参照してください。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

(a)　形式1

DbjReferencePathInfo createReferencePathInfo()

(b)　形式2

DbjReferencePathInfo createReferencePathInfo(
       int           contentOperateMode,
       String        entry,
       String        targetPath,
       String        deleteRootPath )

(3)　引数

contentOperateMode（入力）

contentOperateModeプロパティの初期値を指定します。

entry（入力）

entryプロパティの初期値を指定します。

targetPath（入力）

targetPathプロパティの初期値を指定します。なお，文書空間で使用する文字コード種別がUTF-8の場合に指定できる値は，印刷が可能なASCIIコードだけです。

deleteRootPath（入力）

deleteRootPathプロパティの初期値を指定します。なお，文書空間で使用する文字コード種別がUTF-8の場合に指定できる値は，印刷が可能なASCIIコードだけです。

(4)　戻り値

リファレンスファイル文書のパス情報インターフェース（DbjReferencePathInfoインターフェース）

(5)　例外

なし

2.2.10　createReferenceUploadInfo（リファレンスファイル文書のアップロード情報オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル文書のアップロード情報オブジェクトを作成し，そのインターフェース（DbjReferenceUploadInfoインターフェース）を取得します。

形式1では，オブジェクトのメンバにデフォルト値が入ります。形式2では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.15　DbjReferenceUploadInfoインターフェース」を参照してください。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

(a)　形式1

DbjReferenceUploadInfo createReferenceUploadInfo()

(b)　形式2

DbjReferenceUploadInfo createReferenceUploadInfo(
     String                    filePath,
     String                    retrievalName,
     String                    renditionType,
     DbjPropSet                renditionPropSet,
     String                    indexPath,
     DbjReferencePathInfo      referencePathInfo )

(3)　引数

filePath（入力）

filePathプロパティの初期値を指定します。

retrievalName（入力）

retirievalNameプロパティの初期値を指定します。

renditionType（入力）

renditionTypeプロパティの初期値を指定します。

renditionPropSet（入力）

renditionPropSetプロパティの初期値を指定します。

indexPath（入力）

indexPathプロパティの初期値を指定します。

referencePathInfo（入力）

referencePathInfoプロパティの初期値を指定します。

(4)　戻り値

リファレンスファイル文書のアップロード情報インターフェース（DbjReferenceUploadInfoインターフェース）

(5)　例外

なし

2.2.11　createSeedDocQParam（種文章の?パラメタの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

概念検索で指定する種文章の?パラメタを作成し，そのインターフェース（DbjSeedDocQParamインターフェース）を取得します。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjSeedDocQParam createSeedDocQParam(
    String     param
)

(3)　引数

param（入力）

パラメタの値を指定します。

(4)　戻り値

概念検索の種文章の?パラメタインターフェース（DbjSeedDocQParamインターフェース）

(5)　例外

なし

2.2.12　createSession（Java クラスライブラリのセッションオブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定した文書空間に対するJava クラスライブラリのセッションオブジェクトを作成し，そのインターフェース（DbjSessionインターフェース）を取得します。ただし，DbjSessionインターフェースを取得した時点では文書空間にアクセスしません。

形式1では，セッションを開始する文書空間の文書空間識別子を指定します。形式２では，動作環境定義ファイルに指定したデフォルト文書空間（コンフィギュレーションキーはDefaultDocSpaceId）に接続するためのセッションオブジェクトを作成し，そのインターフェース（DbjSessionインターフェース）を取得します。

(2)　形式

(a)　形式1

DbjSession createSession(
    String     docspaceId
)

(b)　形式2

DbjSession createSession()

(3)　引数

docspaceId（入力）

文書空間識別子をGUID文字列で指定します。GUID文字列は，16進数「X」によって，「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8けた-4けた-4けた-4けた-12けた）」の形式で表されます。「X」は，0～9，a～f（小文字），およびA～F（大文字）のどれかです。nullを指定した場合は，例外がスローされます。

(4)　戻り値

Java クラスライブラリのセッションインターフェース（DbjSessionインターフェース）

(5)　例外

NullPointerException

引数docspaceIdにnullを指定した場合

2.2.13　createSetDCRLinkInfo（直接型リンク設定情報の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

直接型リンク設定情報オブジェクトを作成し，そのインターフェース（DbjSetDCRLinkInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.20　DbjSetDCRLinkInfoインターフェース」を参照してください。

(2)　形式

(a)　形式1

DbjSetDCRLinkInfo createSetDCRLinkInfo()

(b)　形式2

DbjSetDCRLinkInfo createSetDCRLinkInfo(
    DbjObj               obj,
    DbjPropSet           linkProps
)

(3)　引数

obj（入力）

リンク対象の文書空間オブジェクトを指定します。文書空間オブジェクトを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

linkProps（入力）

リンクオブジェクトに設定するプロパティのプロパティ値集合を指定します。プロパティを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

(4)　戻り値

直接型リンク設定情報インターフェース（DbjSetDCRLinkInfoインターフェース）

(5)　例外

なし

2.2.14　createSetRCRLinkInfo（参照型リンク設定情報の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

参照型リンク設定情報オブジェクトを作成し，そのインターフェース（DbjSetRCRLinkInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.22　DbjSetRCRLinkInfoインターフェース」を参照してください。

(2)　形式

(a)　形式1

DbjSetRCRLinkInfo createSetRCRLinkInfo()

(b)　形式2

DbjSetRCRLinkInfo createSetRCRLinkInfo(
    DbjObj           obj,
    DbjPropSet       linkProps
)

(3)　引数

obj（入力）

リンク対象の文書空間オブジェクトを指定します。文書空間オブジェクトを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

linkProps（入力）

リンクオブジェクトに設定するプロパティのプロパティ値集合を指定します。プロパティを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

(4)　戻り値

参照型リンク設定情報インターフェース（DbjSetRCRLinkInfoインターフェース）

(5)　例外

なし

2.2.15　createSetRelLinkInfo（文書間リンク設定情報の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書間リンク設定情報オブジェクトを作成し，そのインターフェース（DbjSetRelLinkInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.23　DbjSetRelLinkInfoインターフェース」を参照してください。

(2)　形式

(a)　形式1

DbjSetRelLinkInfo createSetRelLinkInfo()

(b)　形式2

DbjSetRelLinkInfo createSetRelLinkInfo (
    DbjObj           obj,
    DbjPropSet       linkProps
)

(3)　引数

obj（入力）

リンク対象の文書空間オブジェクト（バージョン付きオブジェクト）を指定します。文書空間オブジェクトを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

linkProps（入力）

リンクオブジェクトに設定するプロパティのプロパティ値集合を指定します。プロパティを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

(4)　戻り値

文書間リンク設定情報インターフェース（DbjSetRelLinkInfoインターフェース）

(5)　例外

なし

2.2.16　createSetVTFixLinkInfo（構成管理モードがFIXモードの構成管理型リンク設定情報の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

構成管理型リンク（構成管理モードはFIXモード）設定情報オブジェクトを作成し，そのインターフェース（DbjSetVTFixLinkInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.24　DbjSetVTFixLinkInfoインターフェース」を参照してください。

(2)　形式

(a)　形式1

DbjSetVTFixLinkInfo createSetVTFixLinkInfo()

(b)　形式2

DbjSetVTFixLinkInfo createSetVTFixLinkInfo(
    DbjObj           obj,
    DbjPropSet       linkProps
)

(3)　引数

obj（入力）

リンク対象の文書空間オブジェクト（バージョン付きオブジェクト）を指定します。文書空間オブジェクトを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

DbjObj#getTargetVersionメソッドで取得できるバージョンに固定した構成管理型リンク情報（構成管理モードはFIXモード）が設定されます。これらの情報はコピーされてリンク設定情報に保持されます。

linkProps（入力）

リンクオブジェクトに設定するプロパティのプロパティ値集合を指定します。プロパティを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

(4)　戻り値

構成管理モードがFIXモードの構成管理型リンク設定情報インターフェース（DbjSetVTFixLinkInfoインターフェース）

(5)　例外

なし

2.2.17　createSetVTFloatLinkInfo（構成管理モードがFLOATINGモードの構成管理型リンク設定情報の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

構成管理型リンク（構成管理モードはFLOATINGモード）設定情報オブジェクトを作成し，そのインターフェース（DbjSetVTFloatLinkInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.25　DbjSetVTFloatLinkInfoインターフェース」を参照してください。

(2)　形式

(a)　形式1

DbjSetVTFloatLinkInfo createSetVTFloatLinkInfo()

(b)　形式2

DbjSetVTFloatLinkInfo createSetVTFloatLinkInfo(
    DbjObj          obj,
    DbjPropSet      linkProps
)

(3)　引数

obj（入力）

リンク対象の文書空間オブジェクト（バージョン付きオブジェクト）を指定します。文書空間オブジェクトを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

DbjObj#getTargetVersionメソッドで取得できるバージョン以降の最新バージョンを指す構成管理型リンク情報（構成管理モードはFLOATINGモード）が設定されます。

linkProps（入力）

リンクオブジェクトに設定するプロパティのプロパティ値集合を指定します。プロパティを未設定にする場合は，nullを指定できます。初期値のデフォルト値はnullです。

(4)　戻り値

構成管理モードがFLOATINGモードの構成管理型リンク設定情報インターフェース（DbjSetVTFloatLinkInfoインターフェース）

(5)　例外

なし

2.2.18　createStringQParam（String型の?パラメタの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

String型の?パラメタを作成し，そのインターフェース（DbjStringQParamインターフェース）を取得します。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjStringQParam createStringQParam(
    String     param
)

(3)　引数

param（入力）

?パラメタの値を指定します。

(4)　戻り値

String型の?パラメタ（DbjStringQParamインターフェース）

(5)　例外

なし

2.2.19　createUploadInfo（文書のアップロード情報オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書アップロード情報オブジェクトを作成し，そのインターフェース（DbjUploadInfoインターフェース）を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，オブジェクトの初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.28　DbjUploadInfoインターフェース」を参照してください。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

(a)　形式1

DbjUploadInfo createUploadInfo()

(b)　形式2

DbjUploadInfo createUploadInfo(
    String          filePath,
    String          retrievalName,
    String          renditionType,
    DbjPropSet      renditionPropSet,
    String          indexPath
)

(3)　引数

filePath（入力）

filePathプロパティの初期値を指定します。

retrievalName（入力）

retrievalNameプロパティの初期値を指定します。

renditionType（入力）

renditionTypeプロパティの初期値を指定します。

renditionPropSet（入力）

renditionPropSetプロパティの初期値を指定します。

indexPath（入力）

indexPathプロパティの初期値を指定します。

(4)　戻り値

アップロード情報インターフェース（DbjUploadInfoインターフェース）

(5)　例外

なし

2.2.20　createVArray（可変長配列オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトを作成し，そのインターフェース（DbjVArrayインターフェース）を取得します。引数に指定されたメタプロパティを保持する要素数０の空の可変長配列オブジェクトを作成します。

(2)　形式

DbjVArray createVArray(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

各要素は，String型のプロパティになります。可変長配列のメタプロパティのコレクションを指定します。指定を省略する場合は，各要素にnullを指定できます。この場合，要素数0の空のオブジェクトが仮定されます。

(4)　戻り値

可変長配列インターフェース（DbjVArrayインターフェース）

(5)　例外

なし

2.2.21　createXmlTranslator（XMLトランスレーターの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XMLトランスレーターインターフェース（DbjXmlTranslatorインターフェース）を取得します。なお，同じ引数の指定値で再度実行してもエラーになりません。

(2)　形式

DbjXmlTranslator createXmlTranslator(
    String     docspaceId,
    String     xmsFileName
)

(3)　引数

docspaceId（入力）

文書空間識別子をGUID文字列で指定します。GUID文字列は，16進数「X」によって「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8けた-4けた-4けた-4けた-12けた）」の形式で表されます。「X」は，0～9，a～f（小文字），およびA～F（大文字）のどれかです。nullを指定した場合は，例外が出力されます。

xmsFileName（入力）

XMSファイル名を指定します。nullを指定した場合は，デフォルトのXMSファイルが仮定されます。

(4)　戻り値

XMLトランスレーターインターフェース（DbjXmlTranslatorインターフェース）

(5)　例外

DbjException

Java クラスライブラリ固有のエラーの場合

IllegalArguemntException

指定した引数が不正の場合

NullPointerException

引数docspaceIdにnullを指定した場合

2.2.22　createXmlUploadInfo（XML文書のアップロード情報オブジェクトの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書アップロード情報オブジェクトを作成し，そのインターフェース(DbjXmlUploadInfoインターフェース)を取得します。

形式１では，オブジェクトのメンバにデフォルト値が入ります。形式２では，初期値を引数で指定できます。オブジェクトの初期値として設定できるパラメタの詳細については，「3.30　DbjXmlUploadInfoインターフェース」を参照してください。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

(a)　形式1

DbjXmlUploadInfo createXmlUploadInfo()

(b)　形式2

DbjXmlUploadInfo createXmlUploadInfo(
    String          filePath,
    String          retrievalName,
    String          renditionType,
    DbjPropSet      renditionPropSet,
    int             parseLevel,
    String          mappingId,
    int             indexType,
    String          filterFilePath
)

(3)　引数

filePath（入力）

filePathプロパティの初期値を指定します。

retrievalName（入力）

retrievalNameプロパティの初期値を指定します。

renditionType（入力）

renditionTypeプロパティの初期値を指定します。

renditionPropSet（入力）

renditionPropSetプロパティの初期値を指定します。

parseLevel（入力）

parseLevelプロパティの初期値を指定します。

mappingId（入力）

mappingIdプロパティの初期値を指定します。

indexType（入力）

indexTypeプロパティの初期値を指定します。

filterFilePath（入力）

filterFilePathプロパティの初期値を指定します。

(4)　戻り値

XML文書アップロード情報インターフェース（DbjXmlUploadInfoインターフェース）

(5)　例外

なし

3.　パラメタクラス詳細

この章では，パラメタクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

3.1　DbjACEインターフェース

3.2　DbjBooleanQParamインターフェース

3.3　DbjCheckOutInfoインターフェース

3.4　DbjContentInfoインターフェース

3.5　DbjFetchInfoインターフェース

3.6　DbjInteger32QParamインターフェース

3.7　DbjMappedPropインターフェース

3.8　DbjObjQParamインターフェース

3.9　DbjOIIDQParamインターフェース

3.10　DbjPropSetインターフェース

3.11　DbjPublicACLIdElmインターフェース

3.12　DbjQParamインターフェース

3.13　DbjReferenceContentInfoインターフェース

3.14　DbjReferencePathInfoインターフェース

3.15　DbjReferenceUploadInfoインターフェース

3.16　DbjRenditionInfoインターフェース

3.17　DbjRenditionListインターフェース

3.18　DbjResultSetインターフェース

3.19　DbjSeedDocQParamインターフェース

3.20　DbjSetDCRLinkInfoインターフェース

3.21　DbjSetLinkInfoインターフェース

3.22　DbjSetRCRLinkInfoインターフェース

3.23　DbjSetRelLinkInfoインターフェース

3.24　DbjSetVTFixLinkInfoインターフェース

3.25　DbjSetVTFloatLinkInfoインターフェース

3.26　DbjSetVTLinkInfoインターフェース

3.27　DbjStringQParamインターフェース

3.28　DbjUploadInfoインターフェース

3.29　DbjVArrayインターフェース

3.30　DbjXmlUploadInfoインターフェース

3.1　DbjACEインターフェース

DbjACEインターフェースは，ACEの値を扱うインターフェースです。ACEの値を取得，または設定するメソッドを提供します。また，サブジェクトと同時にサブジェクト種別を設定するメソッドも提供します。

なお，Java クラスライブラリでは，ACLを可変長配列として扱い，ACEを可変長配列の要素として扱います。このため，ACLはDbjVArrayインターフェースでも操作でき，ACEはDbjPropSetインターフェースでも操作できます。

プロパティ一覧

DbjACEインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-1に示します。

表3-1　DbjACEインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
permission | int型 | getPermission | setPermission
propSet | DbjPropSet | propSet | setPropSet
subject | String型 | getSubject | setSubject
subjectType | int型 | getSubjectType | setSubjectType

プロパティ詳細

permissionプロパティ
ACEのパーミッションを表します。
このプロパティに対する操作は，プロパティ値集合のdbrProp_Permissionプロパティに反映されます。
初期値はDbjDef.PERM_NONE（アクセス権なし）です。

propSetプロパティ
DbjACEインターフェースで扱うプロパティ値の集合です。
このプロパティ値集合に対する操作は，集合に含まれる各プロパティ値に反映されます。また，各プロパティ値に対する操作もこのプロパティ値集合に反映されます。

subjectプロパティ
ACEのサブジェクトを表します。
このプロパティに対する操作は，プロパティ値集合のdbrProp_Subjectプロパティに反映されます。
初期値はnullです。

subjectTypeプロパティ
ACEのサブジェクト種別を表します。
このプロパティに対する操作は，プロパティ値集合のdbrProp_SubjectTypeプロパティに反映されます。
初期値は0です。

以降，DbjACEインターフェースのメソッドについて説明します。

＜この節の構成＞

3.1.1　getPermission（パーミッションの取得）

3.1.2　getSubject（サブジェクトの取得）

3.1.3　getSubjectType（サブジェクト種別の取得）

3.1.4　propSet（ACEのプロパティ値集合の取得）

3.1.5　setGroupSubject（サブジェクトをグループサブジェクトとして設定）

3.1.6　setPermission（パーミッションの設定）

3.1.7　setPropSet（ACEのプロパティ値集合の設定）

3.1.8　setSubject（サブジェクトの設定）

3.1.9　setSubjectType（サブジェクト種別の設定）

3.1.10　setSystemSubject（サブジェクトをシステムサブジェクトとして設定）

3.1.11　setUserSubject（サブジェクトをユーザサブジェクトとして設定）

3.1.1　getPermission（パーミッションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEのパーミッションを取得します。

permissionプロパティに値が設定されていない場合は，0が返却されます。

(2)　形式

int getPermission()

(3)　引数

なし

(4)　戻り値

ACEのパーミッションが，次に示す定数で返却されます。

DbjDef.PERM_NONE
アクセス権なし

DbjDef.PERM_PRIM_READ_PROPS
基本プロパティ参照権

DbjDef.PERM_PRIM_WRITE_PROPS
基本プロパティ更新権

DbjDef.PERM_PRIM_READ_CONTENTS
基本コンテンツ参照権

DbjDef.PERM_PRIM_WRITE_CONTENTS
基本コンテンツ更新権

DbjDef.PERM_PRIM_LINK
基本リンク権

DbjDef.PERM_PRIM_VERSION
基本バージョン管理権

DbjDef.PERM_PRIM_DELETE
基本削除権

DbjDef.PERM_CHANGE_PERM
アクセス制御情報変更権

DbjDef.PERM_CREATE
オブジェクト作成権

DbjDef.PERM_READ_PROPS
プロパティ参照権

DbjDef.PERM_READ
参照権

DbjDef.PERM_WRITE_PROPS
プロパティ更新権

DbjDef.PERM_READ_WRITE
参照更新権

DbjDef.PERM_DELETE
削除権

DbjDef.PERM_LINK
リンク権

DbjDef.PERM_VERSION
バージョン権

DbjDef.PERM_FULL_CONTROL
フルコントロール

(5)　例外

なし

3.1.2　getSubject（サブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEのサブジェクトを取得します。

subjectプロパティに値が設定されていない場合は，nullが返却されます。

(2)　形式

String getSubject()

(3)　引数

なし

(4)　戻り値

subjectプロパティ

ACEのサブジェクトが返却されます。

(5)　例外

なし

3.1.3　getSubjectType（サブジェクト種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEのサブジェクト種別を取得します。

subjectTypeプロパティに値が設定されていない場合は，0が返却されます。

(2)　形式

int getSubjectType()

(3)　引数

なし

(4)　戻り値

ACEのサブジェクト種別が，次に示す定数で返却されます。

DbjDef.SUBJECTTYPE_USR
ユーザサブジェクト

DbjDef.SUBJECTTYPE_GRP
グループサブジェクト

DbjDef.SUBJECTTYPE_SYS
システムサブジェクト

(5)　例外

なし

3.1.4　propSet（ACEのプロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEの値を要素としたプロパティ値集合を取得します。

取得するプロパティ値集合の各要素は，プロパティ値の参照です。なお，値が設定されていなくても，nullは返却されません。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

propSetプロパティ（DbjPropSetインターフェース）

(5)　例外

なし

3.1.5　setGroupSubject（サブジェクトをグループサブジェクトとして設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したサブジェクトをグループサブジェクトとして設定します。subjectTypeプロパティに，DbjDef.SUBJECTTYPE_GRP（グループサブジェクト）が自動的に設定されます。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setGroupSubject(
    String     grpSubject
)

(3)　引数

grpSubject（入力）

グループサブジェクトとして設定するサブジェクトを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.1.6　setPermission（パーミッションの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEのパーミッションを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setPermission(
    int      permission
)

(3)　引数

permission（入力）

ACEのパーミッションを指定します。次に示す定数のどれかを指定できます。

DbjDef.PERM_NONE
アクセス権なし

DbjDef.PERM_PRIM_READ_PROPS
基本プロパティ参照権

DbjDef.PERM_PRIM_WRITE_PROPS
基本プロパティ更新権

DbjDef.PERM_PRIM_READ_CONTENTS
基本コンテンツ参照権

DbjDef.PERM_PRIM_WRITE_CONTENTS
基本コンテンツ更新権

DbjDef.PERM_PRIM_LINK
基本リンク権

DbjDef.PERM_PRIM_VERSION
基本バージョン管理権

DbjDef.PERM_PRIM_DELETE
基本削除権

DbjDef.PERM_CHANGE_PERM
アクセス制御情報変更権

DbjDef.PERM_CREATE
オブジェクト作成権

DbjDef.PERM_READ_PROPS
プロパティ参照権

DbjDef.PERM_READ
参照権

DbjDef.PERM_WRITE_PROPS
プロパティ更新権

DbjDef.PERM_READ_WRITE
参照更新権

DbjDef.PERM_DELETE
削除権

DbjDef.PERM_LINK
リンク権

DbjDef.PERM_VERSION
バージョン権

DbjDef.PERM_FULL_CONTROL
フルコントロール

(4)　戻り値

なし

(5)　例外

なし

3.1.7　setPropSet（ACEのプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEの値に，指定したプロパティ値集合の内容をコピーして設定します。

(2)　形式

void setPropSet(
    DbjPropSet  propSet
)

(3)　引数

propSet（入力）

設定するプロパティ値集合を指定します。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propSetにnullを指定した場合

3.1.8　setSubject（サブジェクトの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEのサブジェクトを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setSubject(
    String     subject
)

(3)　引数

subject（入力）

ACEのサブジェクトを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.1.9　setSubjectType（サブジェクト種別の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ACEのサブジェクト種別を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setSubjectType(
    int      subjectType
)

(3)　引数

subjectType（入力）

ACEのサブジェクト種別を指定します。次に示す定数のどれかを指定できます。

DbjDef.SUBJECTTYPE_USR
ユーザサブジェクト

DbjDef.SUBJECTTYPE_GRP
グループサブジェクト

DbjDef.SUBJECTTYPE_SYS
システムサブジェクト

(4)　戻り値

なし

(5)　例外

なし

3.1.10　setSystemSubject（サブジェクトをシステムサブジェクトとして設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したサブジェクトをシステムサブジェクトとして設定します。subjectTypeプロパティに，DbjDef.SUBJECTTYPE_SYSが自動的に設定されます。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setSystemSubject(
    String      sysSubject
)

(3)　引数

sysSubject（入力）

システムサブジェクトとして設定するサブジェクトを指定します。次に示す定数のどちらかを指定できます。

DbjDef.SYSSUBJECT_SELF
対象オブジェクトの所有者

DbjDef.SYSSUBJECT_EVERYONE
すべてのユーザ

(4)　戻り値

なし

(5)　例外

なし

3.1.11　setUserSubject（サブジェクトをユーザサブジェクトとして設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したサブジェクトをユーザサブジェクトとして設定します。subjectTypeプロパティに，DbjDef.SUBJECTTYPE_USRが自動的に設定されます。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setUserSubject(
    String      usrSubject
)

(3)　引数

usrSubject（入力）

ユーザサブジェクトとして設定するサブジェクトを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.2　DbjBooleanQParamインターフェース

DbjBooleanQParamインターフェースは，BOOL型を表す?パラメタを扱うインターフェースです。

直接のスーパーインターフェース

DbjQParam

3.3　DbjCheckOutInfoインターフェース

DbjCheckOutInfoインターフェースは，バージョン付きオブジェクトのチェックアウト情報を扱うインターフェースです。バージョン付きオブジェクトのチェックアウト情報を取得するメソッドを提供します。チェックアウト中の場合は，チェックアウトしたユーザのユーザ識別子および仮のバージョン識別子を取得できます。

プロパティ一覧

DbjCheckOutInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドを表3-2に示します。

表3-2　DbjCheckOutInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド
checkOut | boolean型 | isCheckOut
checkOutUserId | String型 | getCheckOutUserId
checkOutVersionId | String型 | getCheckOutVersionId

プロパティ詳細

checkOutプロパティ
バージョン付きオブジェクトがチェックアウト中かどうかを表します。
チェックアウト中の場合はtrueとなり，チェックアウトしていない場合はfalseとなります。

checkOutUserIdプロパティ
チェックアウトしたユーザのユーザ識別子を表します。
チェックアウト中の場合にだけ有効です。チェックアウトしていない場合はnullとなります。

checkOutVersionIdプロパティ
チェックアウト中の仮のバージョン識別子を表します。
チェックアウト中の場合にだけ有効です。チェックアウトしていない場合はnullとなります。

以降，DbjCheckOutInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.3.1　getCheckOutUserId（チェックアウトしたユーザのユーザ識別子の取得）

3.3.2　getCheckOutVersionId（仮のバージョン識別子の取得）

3.3.3　isCheckOut（チェックアウト中かどうかの判定）

3.3.1　getCheckOutUserId（チェックアウトしたユーザのユーザ識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

チェックアウトしたユーザのユーザ識別子を取得します。

チェックアウトしていない場合は，nullが返却されます。

(2)　形式

String getCheckOutUserId()

(3)　引数

なし

(4)　戻り値

checkOutUserIdプロパティ

(5)　例外

なし

3.3.2　getCheckOutVersionId（仮のバージョン識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

チェックアウト中の仮のバージョン識別子を取得します。

チェックアウトしていない場合は，nullが返却されます。

(2)　形式

String getCheckOutVersionId()

(3)　引数

なし

(4)　戻り値

checkOutVersionIdプロパティ

(5)　例外

なし

3.3.3　isCheckOut（チェックアウト中かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

チェックアウト中かどうかを判定します。

(2)　形式

boolean isCheckOut()

(3)　引数

なし

(4)　戻り値

true

チェックアウト中です。

false

チェックアウトしていません。

(5)　例外

なし

3.4　DbjContentInfoインターフェース

DbjContentInfoインターフェースは，文書のコンテンツ情報を扱うインターフェースです。コンテンツのレンディションタイプおよびファイル名を取得するメソッドを提供します。

プロパティ一覧

DbjContentInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドを表3-3に示します。

表3-3　DbjContentInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド
renditionType | String型 | getRenditionType
retrievalName | String型 | getRetrievalName

プロパティ詳細

renditionTypeプロパティ
コンテンツのレンディションタイプを表します。文書オブジェクトのdbrProp_RenditionTypeプロパティと同じ値です。

retrievalNameプロパティ
コンテンツのファイル名を表します。文書オブジェクトのdbrProp_RetrievalNameプロパティと同じ値です。

以降，DbjContentInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.4.1　getRenditionType（コンテンツのレンディションタイプの取得）

3.4.2　getRetrievalName（コンテンツのファイル名の取得）

3.4.1　getRenditionType（コンテンツのレンディションタイプの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツのレンディションタイプを取得します。

(2)　形式

String getRenditionType()

(3)　引数

なし

(4)　戻り値

renditionTypeプロパティ

(5)　例外

なし

3.4.2　getRetrievalName（コンテンツのファイル名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツのファイル名を取得します。

(2)　形式

String getRetrievalName()

(3)　引数

なし

(4)　戻り値

retrievalNameプロパティ

(5)　例外

なし

3.5　DbjFetchInfoインターフェース

DbjFetchInfoインターフェースは，検索結果取得情報を扱うインターフェースです。検索結果の取得開始位置，取得件数および最大取得件数などを取得，設定するメソッドを提供します。また，キャッシュ検索の実行時に使用するキャッシュ名およびキャッシュキーを取得，設定できます。

キャッシュ検索を実行すると検索結果がキャッシュされ，以降の検索では検索結果キャッシュから検索結果を取得できます。検索結果キャッシュは，同一セッションの同一キャッシュ名に対して有効です。

直接のスーパーインターフェース

java.lang.Cloneable
DbjFetchInfoインターフェースのcloneメソッドは，ディープコピーを実行します。

プロパティ一覧

DbjFetchInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-4に示します。

表3-4　DbjFetchInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
cacheKey | int型 | getCacheKey | setCacheKey
cacheName | String型 | getCacheName | setCacheName
cacheTotal | int型 | getCacheTotal | setCacheTotal
comparator | Comparator | getComparator | setComparator
fetchCount | int型 | getFetchCount | setFetchCount
maxFetchCount | int型 | getMaxFetchCount | setMaxFetchCount
startIndex | int型 | getStartIndex | setStartIndex

プロパティ詳細

cacheKeyプロパティ
キャッシュ検索の実行時に，検索結果キャッシュの整合性をチェックするためのキーです。キャッシュキーはINT型の値で，再検索を実行して検索結果キャッシュが更新されるごとにインクリメントされます。キャッシュ検索を実行しない時，またはキャッシュ検索の初回実行時は無効です。
指定したキャッシュキーと検索結果キャッシュに保持されているキーが一致した場合は，データベースへはアクセスしないで，検索結果キャッシュから検索結果を取得します。キャッシュキーが不一致の場合は，データベースを再検索して検索結果を取得します。このとき，検索結果キャッシュは更新されます。
キャッシュ検索を実行しない場合（データベースを再検索する場合）は，キャッシュキーにDbjDef.INITIAL_KEYを指定してください。
初期値はDbjDef.INITIAL_KEYです。

cacheNameプロパティ
検索結果のキャッシュ名を表します。キャッシュ検索を実行する場合に指定します。nullまたは「""」（空文字列）を指定すると，キャッシュ検索を実行しません（検索結果はキャッシュされません）。
初期値はnullです。

cacheTotalプロパティ
キャッシュ検索の実行時に設定される検索結果キャッシュの全件数を表します。
初期値は0です。

comparatorプロパティ
検索結果取得時に検索結果キャッシュの内容をソートする場合に使用する，java.util.Comparatorインターフェースを表します。nullを指定すると，検索結果キャッシュの内容はソートされません。
初期値はnullです。
検索結果キャッシュの内容をソートする際には，java.util.Comparator#compareメソッドを実装して，検索結果の要素を比較する必要があります。また，java.util.Comparator#equalsメソッドを実装して，検索結果キャッシュに保持されているコンパレータと，今回の検索結果のコンパレータが等しいかどうかを判定する必要があります。コンパレータが等しいかどうかを判定する対象には，異なるインスタンスのコンパレータを指定してください。
コンパレータが等しいかどうかを判定した結果，等しい場合は，検索結果キャッシュはソートされません。等しくない場合は，検索結果キャッシュがソートされます。なお，キャッシュキーが一致している場合で，コンパレータが等しくないときは，データベースへの再検索は実行されないで，検索結果キャッシュのソートだけが実行されます。

fetchCountプロパティ
検索結果の取得件数（検索結果を実際に何件取得するか）を表します。最大件数を取得したい場合は，DbjDef.MAX_NUMを指定します。
キャッシュ検索では，検索結果キャッシュに保持している件数以上は取得できません。
初期値はDbjDef.MAX_NUMです。

maxFetchCountプロパティ
キャッシュ検索を実行する場合に，検索結果の最大取得件数（検索結果を最大で何件まで取得するか）を指定します。最大件数を取得したい場合は，DbjDef.MAX_NUMを指定します。
初期値はDbjDef.MAX_NUMです。

startIndexプロパティ
検索結果の取得開始位置を表します。開始位置は0から始まるインデクスで指定します。
キャッシュ検索では，検索結果キャッシュ上の開始位置を表します。
初期値は0です。

以降，DbjFetchInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.5.1　getCacheKey（キャッシュキーの取得）

3.5.2　getCacheName（キャッシュ名の取得）

3.5.3　getCacheTotal（検索結果キャッシュの全件数の取得）

3.5.4　getComparator（Comparatorインターフェースの取得）

3.5.5　getFetchCount（検索結果の取得件数の取得）

3.5.6　getMaxFetchCount（検索結果の最大取得件数の取得）

3.5.7　getStartIndex（検索結果の取得開始位置の取得）

3.5.8　setCacheKey（キャッシュキーの設定）

3.5.9　setCacheName（キャッシュ名の設定）

3.5.10　setCacheTotal（検索結果キャッシュの全件数の設定）

3.5.11　setComparator（Comparatorインターフェースの設定）

3.5.12　setFetchCount（検索結果の取得件数の設定）

3.5.13　setMaxFetchCount（検索結果の最大取得件数の設定）

3.5.14　setStartIndex（検索結果の取得開始位置の設定）

3.5.1　getCacheKey（キャッシュキーの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

キャッシュキーを取得します。

(2)　形式

int getCacheKey()

(3)　引数

なし

(4)　戻り値

cacheKeyプロパティ

(5)　例外

なし

3.5.2　getCacheName（キャッシュ名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

キャッシュ名を取得します。

(2)　形式

String getCacheName()

(3)　引数

なし

(4)　戻り値

cacheNameプロパティ

(5)　例外

なし

3.5.3　getCacheTotal（検索結果キャッシュの全件数の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果キャッシュの全件数を取得します。

(2)　形式

int getCacheTotal()

(3)　引数

なし

(4)　戻り値

cacheTotalプロパティ

(5)　例外

なし

3.5.4　getComparator（Comparatorインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

java.util.Comparatorインターフェースを取得します。

(2)　形式

Comparator getComparator()

(3)　引数

なし

(4)　戻り値

java.util.Comparatorインターフェース

(5)　例外

なし

3.5.5　getFetchCount（検索結果の取得件数の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果の取得件数（検索結果を実際に何件取得するか）を取得します。

(2)　形式

int getFetchCount()

(3)　引数

なし

(4)　戻り値

fetchCountプロパティ

(5)　例外

なし

3.5.6　getMaxFetchCount（検索結果の最大取得件数の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果の最大取得件数（検索結果を最大で何件まで取得するか）を取得します。

(2)　形式

int getMaxFetchCount()

(3)　引数

なし

(4)　戻り値

maxFetchCountプロパティ

(5)　例外

なし

3.5.7　getStartIndex（検索結果の取得開始位置の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果の取得開始位置を取得します。

(2)　形式

int getStartIndex()

(3)　引数

なし

(4)　戻り値

startIndexプロパティ

(5)　例外

なし

3.5.8　setCacheKey（キャッシュキーの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

キャッシュキーを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setCacheKey(
    int      cacheKey
)

(3)　引数

cacheKey（入力）

キャッシュキーを指定します。

キャッシュ検索を実行しない場合は，DbjDef.INITIAL_KEYを指定してください。

(4)　戻り値

なし

(5)　例外

なし

3.5.9　setCacheName（キャッシュ名の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

キャッシュ名を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setCacheName(
    String      cacheName
)

(3)　引数

cacheName（入力）

キャッシュ名を指定します。

キャッシュ検索を実行しない場合は，nullまたは「""」（空文字列）を指定してください。

(4)　戻り値

なし

(5)　例外

なし

3.5.10　setCacheTotal（検索結果キャッシュの全件数の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果キャッシュの全件数を表すcacheTotalプロパティを設定します。

(2)　形式

void setCacheTotal(
    int             cacheTotal
)

(3)　引数

cacheTotal（入力）

cacheTotalプロパティに設定する値を指定します。

(4)　戻り値

なし

(5)　例外

なし

3.5.11　setComparator（Comparatorインターフェースの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

java.util.Comparatorインターフェースを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setComparator(
    Comparator      comp
)

(3)　引数

comp（入力）

java.util.Comparatorインターフェースを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.5.12　setFetchCount（検索結果の取得件数の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果の取得件数（検索結果を実際に何件取得するか）を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setFetchCount(
    int      fetchCount
)

(3)　引数

fetchCount（入力）

検索結果の取得件数を指定します。

最大件数取得したい場合は，DbjDef.MAX_NUMを指定してください。

(4)　戻り値

なし

(5)　例外

なし

3.5.13　setMaxFetchCount（検索結果の最大取得件数の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果の最大取得件数（検索結果を最大で何件まで取得するか）を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setMaxFetchCount(
    int      maxFetchCount
)

(3)　引数

maxFetchCount（入力）

検索結果の最大取得件数を指定します。

全件取得したい場合は，DbjDef.MAX_NUMを指定してください。

(4)　戻り値

なし

(5)　例外

なし

3.5.14　setStartIndex（検索結果の取得開始位置の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果の取得を開始する位置を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setStartIndex(
    int      startIndex
)

(3)　引数

startIndex（入力）

検索結果の取得開始位置を指定します。

0から始まるインデクスで指定してください。

(4)　戻り値

なし

(5)　例外

なし

3.6　DbjInteger32QParamインターフェース

DbjInteger32QParamインターフェースは，INT型を表す?パラメタを扱うインターフェースです。

直接のスーパーインターフェース

DbjQParam

3.7　DbjMappedPropインターフェース

DbjMappedPropインターフェースは，XMLプロパティマッピング結果情報を扱うインターフェースです。XMLプロパティマッピング機能を実行して取得した情報を取得するメソッドを提供します。

プロパティ一覧

DbjMappedPropインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドを表3-5に示します。

表3-5　DbjMappedPropインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド
classList | List型（各要素はString型） | getClassList
propSet | DbjPropSet | propSet

プロパティ詳細

classListプロパティ
マッピングされたDMAクラス名のリストです。
バージョン付きオブジェクトのDMAクラスがマッピングされた場合，リストとして取得するDMAクラス名の順序は，「バージョニングオブジェクトのDMAクラス名」，「バージョンオブジェクトのDMAクラス名」となります。バージョン付きオブジェクトのDMAクラス以外がマッピングされた場合，要素は一つとなります。

propSetプロパティ
マッピングされたプロパティ値集合です。
なお，バージョン付きオブジェクトのDMAクラスがマッピングされた場合は，バージョンオブジェクトのプロパティ名に＠プレフィックスが付けられます。

以降，DbjMappedPropインターフェースのメソッドについて説明します。

＜この節の構成＞

3.7.1　getClassList（マッピングされたDMAクラス名のリストの取得）

3.7.2　propSet（マッピングされたプロパティ値集合の取得）

3.7.1　getClassList（マッピングされたDMAクラス名のリストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

プロパティマッピングされたDMAクラス名のリストを取得します。

(2)　形式

List getClassList()

(3)　引数

なし

(4)　戻り値

classListプロパティ

(5)　例外

なし

3.7.2　propSet（マッピングされたプロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

プロパティマッピングされたプロパティ値集合を取得します。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

propSetプロパティ（DbjPropSetインターフェース）

(5)　例外

なし

3.8　DbjObjQParamインターフェース

DbjObjQParamインターフェースは，文書空間オブジェクトを表す?パラメタを扱うインターフェースです。

直接のスーパーインターフェース

DbjQParam

3.9　DbjOIIDQParamインターフェース

DbjOIIDQParamインターフェースは，OIID文字列を表す?パラメタを扱うインターフェースです。

直接のスーパーインターフェース

DbjQParam

3.10　DbjPropSetインターフェース

DbjPropSetインターフェースは，プロパティ値集合を扱うインターフェースです。プロパティ値を取得，設定するメソッド，およびプロパティ名を変更するメソッドを提供します。

プロパティ値集合とは，文書空間オブジェクトのプロパティ名とそのプロパティ値を一組にした要素の集合オブジェクトです。要素のキーを文書空間オブジェクトのプロパティ名とし，要素の値をそのプロパティ値とするマップで表します。

直接のスーパーインターフェース

java.lang.Cloneable
DbjPropSetインターフェースのcloneメソッドは，ディープコピーを実行します。

java.util.Map
DbjPropSetインターフェースは，java.util.Mapインターフェースを継承します。したがって，プロパティ値集合にプロパティ間（要素間）の順序性はなく，プロパティ名（要素のキー）は重複しません。また，マップに対する一般的な操作を使用して，プロパティ値集合を操作することもできます。

コーディング例

// ユーザアプリケーションプログラムのコーディング例
// mdmProp_Nameプロパティ（STR型），
// mdmProp_Numberプロパティ（INT型）について，
// name，numberで与えられた値でプロパティ値集合を作成します。

DbjPropSet MakeProps(String name, int number)
{
// ファクトリから空プロパティ値集合を取得
 DbjPropSet propset = DbjFactory0200.getFactory().createPropSet();

// mdmProp_Nameプロパティの設定
 propset.setPropVal("mdmProp_Name", name);

// mdmProp_Numberプロパティの設定
 propset.setPropVal("mdmProp_Number", number);

 return propset;
}

以降，DbjPropSetインターフェースのメソッドについて説明します。

＜この節の構成＞

3.10.1　changePropName（プロパティ名の変更）

3.10.2　changePropNames（プロパティ名の一括変更）

3.10.3　getIntegerVal（Integer型でのプロパティ値の取得）

3.10.4　getIntVal（int型でのプロパティ値の取得）

3.10.5　getListRef（List型でのプロパティ値の取得）

3.10.6　getStringVal（String型でのプロパティ値の取得）

3.10.7　getVArrayRef（VARRAY型でのプロパティ値の参照の取得）

3.10.8　getVArrayVal（VARRAY型でのプロパティ値の取得）

3.10.9　isNull（プロパティ値がNULL値かどうかの判定）

3.10.10　setNull（NULL値プロパティの設定）

3.10.11　setPropRef（プロパティ値の参照の設定）

3.10.12　setPropVal（プロパティ値の設定）

3.10.1　changePropName（プロパティ名の変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティのプロパティ名を変更します。

変更後のプロパティ名がすでに存在していても，例外はスローされません。ただし，プロパティ名が変更前，変更後のどちらになるかは保証できません。

なお，指定したプロパティ名がプロパティ値集合にない場合は，falseが返却されます。

(2)　形式

boolean changePropName(
    String      oldName,
    String      newName
)

(3)　引数

oldName（入力）

変更前のプロパティ名を指定します。

nullを指定した場合は，例外がスローされます。

newName（入力）

変更後のプロパティ名を指定します。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

true

変更されました。

false

変更されませんでした。

(5)　例外

NullPointerException

引数oldNameまたはnewNameにnullを指定した場合

3.10.2　changePropNames（プロパティ名の一括変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したマップの内容に従って，プロパティ名を一括変更します。マップは，要素のキーに変更前のプロパティ名を，要素の値に変更後のプロパティ名を設定します。

変更後のプロパティ名がすでに存在していても，例外はスローされません。ただし，プロパティ名が変更前，変更後のどちらになるかは保証できません。

なお，変更前として指定したプロパティ名がプロパティ値集合にない場合は，falseが返却されます。

(2)　形式

boolean changePropNames(
    Map      changeMap
)

(3)　引数

changeMap（入力）

変更前と変更後のプロパティ名を設定したマップを指定します。

(4)　戻り値

true

一つ以上変更されました。

false

変更されませんでした。

(5)　例外

NullPointerException

指定したマップの任意のキーまたは値にnullを指定した場合

3.10.3　getIntegerVal（Integer型でのプロパティ値の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値をInteger型で取得します。

指定したプロパティがない場合，またはプロパティの値がNULL値の場合は，nullが返却されます。プロパティの値がINT型でない場合は，例外がスローされます。

(2)　形式

Integer getIntegerVal(
    String      propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

プロパティ値（Integer型）

(5)　例外

ClassCastException

プロパティ値がINT型でなかった場合

NullPointerException

引数propNameにnullを指定した場合

3.10.4　getIntVal（int型でのプロパティ値の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値をint型で取得します。

指定したプロパティがない場合，またはプロパティの値がNULL値の場合は，0が返却されます。プロパティの値がINT型でない場合は，java.lang.Object#toStringメソッドの実行結果がさらにint型の値に変換されて返却されます。

(2)　形式

int getIntVal(
    String     propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

プロパティ値（int型）

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

NumberFormatException

数値変換に失敗した場合

3.10.5　getListRef（List型でのプロパティ値の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値をList型で取得します。このメソッドは，ログインユーザのユーザ情報（dbrProp_GroupListプロパティ）の参照を取得するのに使用します。

指定したプロパティがない場合，またはプロパティの値がNULL値の場合は，nullが返却されます。プロパティの値がSTRLIST型でない場合は，例外がスローされます。

(2)　形式

List getListRef(
    String      propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

プロパティ値のリスト（Listインターフェース）

(5)　例外

ClassCastException

プロパティ値がSTRLIST型でなかった場合

NullPointerException

引数propNameにnullを指定した場合

3.10.6　getStringVal（String型でのプロパティ値の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値をString型で取得します。

指定したプロパティがない場合，またはプロパティの値がNULL値の場合は，nullが返却されます。プロパティの値がSTR型でない場合は，java.lang.Object#toStringメソッドを実行した結果が返却されます。

(2)　形式

String getStringVal(
    String      propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

プロパティ値（String型）

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.10.7　getVArrayRef（VARRAY型でのプロパティ値の参照の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したVARRAY型プロパティの値の参照を取得します。

指定したプロパティがない場合，またはプロパティの値がNULL値の場合は，nullが返却されます。プロパティの値がVARRAY型でない場合は，例外がスローされます。

(2)　形式

DbjVArray getVArrayRef(
    String      propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

VARRAY型プロパティ値の参照（DbjVArrayインターフェース）

(5)　例外

ClassCastException

プロパティ値がVARRAY型でなかった場合

NullPointerException

引数propNameにnullを指定した場合

3.10.8　getVArrayVal（VARRAY型でのプロパティ値の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したVARRAY型プロパティの値のコピーを取得します。

指定したプロパティがない場合，またはプロパティの値がNULL値の場合は，nullが返却されます。プロパティの値がVARRAY型でない場合は，例外がスローされます。

なお，取得するプロパティ値は，次に示すメソッドの実行結果と同じです。ただし，getVArrayValメソッドでは，プロパティ値がNULL値の場合にnullが返却されます。

DbjVArray getVArrayRef(propName).clone()

(2)　形式

DbjVArray getVArrayVal(
    String     propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

VARRAY型プロパティ値（DbjVArrayインターフェース）

(5)　例外

ClassCastException

プロパティ値がVARRAY型でなかった場合

NullPointerException

引数propNameにnullを指定した場合

3.10.9　isNull（プロパティ値がNULL値かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値がNULL値かどうかを判定します。

指定したプロパティがない場合は，trueが返却されます。

(2)　形式

boolean isNull(
    String     propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

true

NULL値です。または指定したプロパティがありません。

false

NULL値以外です。

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.10.10　setNull（NULL値プロパティの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値にNULL値を設定します。

同一プロパティがある場合は上書きします。

(2)　形式

void setNull(
    String    propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.10.11　setPropRef（プロパティ値の参照の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値の参照を設定します。

同一プロパティがある場合は上書きします。

(2)　形式

void setPropRef(
    String      propName,
    DbjVArray   ref
)

(3)　引数

propName（入力）

プロパティ名を指定します。

ref（入力）

プロパティ値を指定します。nullを指定できます。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.10.12　setPropVal（プロパティ値の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティの値を設定します。

同一プロパティがある場合は上書きします。

形式2では，プロパティ値がINT型のオブジェクトにラップされて設定されます。

形式4では，指定したVARRAY型の値がコピーされて設定されます。実行結果は次に示すメソッドの実行結果と同じです。

setVArrayRef(propName,(DbjVArray)val.clone())

ただし，setPropValメソッドの形式4では，valにnullを指定した場合，次に示すメソッドの実行結果と同じになります。

setVArrayRef(propName,null)

(2)　形式

(a)　形式1

void setPropVal(
    String     propName,
    String     val
)

(b)　形式2

void setPropVal(
    String     propName,
    int        val
)

(c)　形式3

void setPropVal(
    String     propName,
    Integer    val
)

(d)　形式4

void setPropVal(
    String      propName,
    DbjVArray   val
)

(3)　引数

propName（入力）

プロパティ名を指定します。

val（入力）

プロパティ値を指定します。形式1，形式3または形式4の場合は，nullを指定するとプロパティにNULL値を設定できます。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.11　DbjPublicACLIdElmインターフェース

DbjPublicACLIdElmインターフェースは，文書空間オブジェクトにバインドするパブリックACLのOIID文字列を扱うインターフェースです。パブリックACLのOIID文字列を取得，設定するメソッドを提供します。

なお，Java クラスライブラリでは，文書空間オブジェクトにバインドするパブリックACLのOIID文字列のリストを，DbjVArrayインターフェースで操作できます。また，その要素であるパブリックACLのOIID文字列はDbjPropSetインターフェースでも操作できます。

プロパティ一覧

DbjPublicACLIdElmインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-6に示します。

表3-6　DbjPublicACLIdElmインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
Id | String型 | getId | setId
propSet | DbjPropSet | propSet | setPropSet

プロパティ詳細

Idプロパティ
パブリックACLのOIID文字列を表します。
このプロパティへのアクセスは，プロパティ値集合のdbrProp_PublicACLIdElemプロパティに反映されます。
初期値はnullです。

propSetプロパティ
DbjPublicACLIdElmインターフェースで扱うプロパティ値の集合です。
このプロパティ値集合に対する操作は，集合に含まれる各プロパティ値に反映されます。また，各プロパティ値に対する操作もこのプロパティ値集合に反映されます。

以降，DbjPublicACLIdElmインターフェースのメソッドについて説明します。

＜この節の構成＞

3.11.1　getId（パブリックACLのOIID文字列の取得）

3.11.2　propSet（パブリックACLのOIID文字列のプロパティ値集合の取得）

3.11.3　setId（パブリックACLのOIID文字列の設定）

3.11.4　setPropSet（パブリックACLのOIID文字列のプロパティ値集合の設定）

3.11.1　getId（パブリックACLのOIID文字列の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

パブリックACLのOIID文字列を取得します。

idプロパティに値が設定されていない場合は，nullが返却されます。

(2)　形式

String getId()

(3)　引数

なし

(4)　戻り値

Idプロパティ

(5)　例外

なし

3.11.2　propSet（パブリックACLのOIID文字列のプロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

パブリックACLのOIID文字列を要素としたプロパティ値集合を取得します。

取得するプロパティ値集合の各要素は，プロパティ値の参照です。なお，値が設定されていなくても，nullは返却されません。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

propSetプロパティ（DbjPropSetインターフェース）

(5)　例外

なし

3.11.3　setId（パブリックACLのOIID文字列の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

パブリックACLのOIID文字列を設定します。

(2)　形式

void setId(
    String     id
)

(3)　引数

id（入力）

パブリックACLのOIID文字列を指定します。nullを指定できます。

(4)　戻り値

なし

(5)　例外

なし

3.11.4　setPropSet（パブリックACLのOIID文字列のプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

パブリックACLのOIID文字列を要素としたプロパティ値集合に，指定したプロパティ値集合の内容をコピーして設定します。

(2)　形式

void setPropSet(
    DbjPropSet     propSet
)

(3)　引数

propSet（入力）

パブリックACLのOIID文字列のプロパティ値集合を指定します。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propSetにnullを指定した場合

3.12　DbjQParamインターフェース

DbjQParamインターフェースは，検索メソッドで指定する?パラメタリストの要素となるインターフェースのスーパーインターフェースです。

直接のスーパーインターフェース

java.lang.Cloneable

＜この節の構成＞

3.12.1　getVal（?パラメタ値の取得）

3.12.1　getVal（?パラメタ値の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

オブジェクトに設定されている?パラメタの値をObject型で取得します。

?パラメタの値がINT型の場合は，INT型オブジェクトの値が返却されます。値が設定されていない場合，またはNULL値の場合は，nullが返却されます。

(2)　形式

Object getVal()

(3)　引数

なし

(4)　戻り値

?パラメタ値（Object型）

(5)　例外

なし

3.13　DbjReferenceContentInfoインターフェース

DbjReferenceContentInfoインターフェースは，リファレンスファイル文書のコンテンツ情報を扱うインターフェースです。リファレンスファイル文書のコンテンツロケーションおよびリファレンス種別を取得するメソッドを提供します。

直接のスーパーインターフェース

DbjContentInfo

プロパティ一覧

DbjReferenceContentInfoインターフェースで扱うプロパティ一覧と，各プロパティに対するgetterメソッドを表3-7に示します。

表3-7　DbjReferenceContentInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド
contentLocation | String型 | getContentLocation
referenceType | int型 | getReferenceType

プロパティ詳細

contentLocationプロパティ
コンテンツロケーションを表します。
文書オブジェクトのdbrProp_ContentLocationプロパティと同じ値です。

referenceTypeプロパティ
コンテンツのリファレンス種別を表します。
文書オブジェクトのdbrProp_ReferenceTypeプロパティと同じ値です。

以降，DbjReferenceContentInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.13.1　getContentLocation（コンテンツロケーションの取得）

3.13.2　getReferenceType（リファレンス種別の取得）

3.13.1　getContentLocation（コンテンツロケーションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツロケーションを取得します。

(2)　形式

String getContentLocation()

(3)　引数

なし

(4)　戻り値

contentLocationプロパティ

(5)　例外

なし

3.13.2　getReferenceType（リファレンス種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンス種別を取得します。

(2)　形式

int getReferenceType()

(3)　引数

なし

(4)　戻り値

referenceTypeプロパティ

(5)　例外

なし

3.14　DbjReferencePathInfoインターフェース

DbjReferencePathInfoインターフェースは，リファレンスファイル文書のパス情報を扱うインターフェースです。リファレンスファイル文書のパス情報を取得，設定するメソッドを提供します。

プロパティ一覧

DbjReferencePathInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-8に示します。

表3-8　DbjReferencePathInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
contentOperateMode | int型 | getContentOperateMode | setContentOperateMode
deleteRootPath | String型 | getDeleteRootPath | setDeleteRootPath
entry | String型 | getEntry | setEntry
targetPath | String型 | getTargetPath | setTargetPath

プロパティ詳細

contentOperateModeプロパティ
コンテンツのパス操作モードを表します。
初期値はDbjDef.OPERATEMODE_NONEです。コンテンツロケーションをコンテンツの相対パスで管理する場合は，DbjDef.OPERATEMODE_USER_RELATIVE_CONTENTを指定します。コンテンツがないオブジェクトを作成する場合は，DbjDef.OPERATEMODE_NONEを指定します。

deleteRootPathプロパティ
リファレンスファイル文書を削除する場合に，コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの，削除するディレクトリのルートパスを表します。
削除の対象となるディレクトリは，コンテンツロケーション（dbrProp_ContentLocationプロパティ）で示されるパス上の格納ディレクトリから，deleteRootPathプロパティで指定したディレクトリの下位までの間にあるディレクトリです。最下位層のディレクトリから順に削除し，エラーとなった時点で処理を終了します。
deleteRootPathプロパティに指定したパスがコンテンツロケーションのパスと一致していない場合はエラーになります。
初期値はnullです。nullを指定した場合，登録されているコンテンツ，およびDocumentBrokerがコンテンツを管理するためのディレクトリが削除されます。
なお，deleteRootPathプロパティの指定は，コンテンツが登録されているオブジェクトに対してだけ有効になります。
また，deleteRootPathプロパティに指定できるのは，DbjSession#setReferencePathメソッドで指定したコンテンツ格納先ベースパスから，コンテンツ格納先ベースパスとtargetPathプロパティで示されるコンテンツ格納先パスの間のパスです。コンテンツ格納先ベースパスより上位のパス，およびDocumentBrokerがコンテンツを管理するためのディレクトリのパスは指定できません。

entryプロパティ
登録するコンテンツのパスまたはダウンロード先のパスを表します。
初期値はnullです。

targetPathプロパティ
サーバ上のコンテンツの格納先となるディレクトリのパス（コンテンツ格納先パス）を表します。初期値はnullです。
コンテンツロケーション（dbrProp_ContentLocationプロパティ）には，targetPathプロパティで指定したパス，DocumentBrokerがコンテンツを管理するためのディレクトリのパス，およびentryプロパティで指定したファイル名を結合した値が格納されます。このとき，区切り文字には半角の「/」が設定されます。

以降，DbjReferencePathInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.14.1　getContentOperateMode（コンテンツのパス操作モードの取得）

3.14.2　getDeleteRootPath（削除するディレクトリのルートパスの取得）

3.14.3　getEntry（登録するコンテンツのパスまたはダウンロード先のパスの取得）

3.14.4　getTargetPath（コンテンツ格納先パスの取得）

3.14.5　setContentOperateMode（コンテンツのパス操作モードの設定）

3.14.6　setDeleteRootPath（削除するディレクトリのルートパスの設定）

3.14.7　setEntry（登録するコンテンツのパスまたはダウンロード先のパスの設定）

3.14.8　setTargetPath（コンテンツ格納先パスの設定）

3.14.1　getContentOperateMode（コンテンツのパス操作モードの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツのパス操作モードを取得します。

(2)　形式

int getContentOperateMode()

(3)　引数

なし

(4)　戻り値

contentOperateModeプロパティ

(5)　例外

なし

3.14.2　getDeleteRootPath（削除するディレクトリのルートパスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル文書を削除する場合に，コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの，削除するディレクトリのルートパスを取得します。

(2)　形式

String getDeleteRootPath()

(3)　引数

なし

(4)　戻り値

deleteRootPathプロパティ

(5)　例外

なし

3.14.3　getEntry（登録するコンテンツのパスまたはダウンロード先のパスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録するコンテンツのパスまたはダウンロード先のパスを取得します。

(2)　形式

String getEntry()

(3)　引数

なし

(4)　戻り値

entryプロパティ

(5)　例外

なし

3.14.4　getTargetPath（コンテンツ格納先パスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツ格納先パスを取得します。

(2)　形式

String getTargetPath()

(3)　引数

なし

(4)　戻り値

targetPathプロパティ

(5)　例外

なし

3.14.5　setContentOperateMode（コンテンツのパス操作モードの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツのパス操作モードを設定します。なお，指定した値の妥当性は，検証されません。

(2)　形式

void setContentOperateMode(
               int     contentOperateMode
)

(3)　引数

contentOperateMode（入力）

コンテンツのパス操作モードを指定します。次に示す定数のどちらかを指定できます。

OPERATEMODE_NONE

OPERATEMODE_USER_RELATIVE_CONTENT

(4)　戻り値

なし

(5)　例外

なし

3.14.6　setDeleteRootPath（削除するディレクトリのルートパスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル文書を削除する場合に，コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの，削除するディレクトリのルートパスを設定します。なお，指定した値の妥当性は，検証されません。

(2)　形式

void setDeleteRootPath(
               String  deleteRootPath
)

(3)　引数

deleteRootPath（入力）

リファレンスファイル文書を削除する場合に，コンテンツの削除と同時にコンテンツを格納したディレクトリを削除するときの，削除するディレクトリのルートパスを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.14.7　setEntry（登録するコンテンツのパスまたはダウンロード先のパスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録するコンテンツのパスまたはダウンロード先のパスを設定します。なお，指定した値の妥当性は，検証されません。

(2)　形式

void setEntry (
              String  entry
)

(3)　引数

entry（入力）

登録するコンテンツのパスまたはダウンロード先のパスを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.14.8　setTargetPath（コンテンツ格納先パスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

コンテンツ格納先パスを設定します。なお，指定した値の妥当性は，検証されません。

(2)　形式

void setTargetPath(
               String  targetPath
)

(3)　引数

targetPath（入力）

コンテンツ格納先パスを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.15　DbjReferenceUploadInfoインターフェース

DbjReferenceUploadInfoインターフェースは，リファレンスファイル文書のアップロード情報を扱うインターフェースです。リファレンスファイル文書のアップロード情報を取得，設定するメソッドを提供します。

直接のスーパーインターフェース

DbjUploadInfo

プロパティ一覧

DbjReferenceUploadInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-9に示します。

表3-9　DbjReferenceUploadInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
referencePathInfo | DbjReferencePathInfo | getReferencePathInfo | setReferencePathInfo

プロパティ詳細

referencePathInfoプロパティ
リファレンスファイル文書のパス情報を表します。

DbjUploadInfoインターフェースから継承するプロパティ詳細

filePathプロパティ
このインターフェースでは使用しません。設定した場合，設定値は無視されます。

indexPathプロパティ
登録するリファレンスファイル文書の全文検索インデクスを作成するファイルのフルパスを表します。

renditionPropSetプロパティ
登録するリファレンスファイル文書のレンディションプロパティ値集合です。

renditionTypeプロパティ
登録するリファレンスファイル文書のレンディションタイプを表します。

retrievalNameプロパティ
登録するリファレンスファイル文書のクライアント側でのローカルファイル名を表します。

以降，DbjReferenceUploadInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.15.1　getReferencePathInfo（リファレンスファイル文書のパス情報の取得）

3.15.2　setReferencePathInfo（リファレンスファイル文書のパス情報の設定）

3.15.1　getReferencePathInfo（リファレンスファイル文書のパス情報の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル文書のパス情報を取得します。

(2)　形式

DbjReferencePathInfo getReferencePathInfo()

(3)　引数

なし

(4)　戻り値

referencePathInfoプロパティ

(5)　例外

なし

3.15.2　setReferencePathInfo（リファレンスファイル文書のパス情報の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル文書のパス情報を設定します。なお，指定した値の妥当性は，検証されません。

(2)　形式

void setReferencePathInfo(
                       DbjReferencePathInfo referencePathInfo
)

(3)　引数

referencePathInfo（入力）

リファレンスファイル文書のパス情報を指定します。

(4)　戻り値

なし

(5)　例外

なし

3.16　DbjRenditionInfoインターフェース

DbjRenditionInfoインターフェースは，レンディション情報を扱うインターフェースです。レンディションタイプを取得するメソッドを提供します。

プロパティ一覧

DbjRenditionInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドを表3-10に示します。

表3-10　DbjRenditionInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド
propSet | DbjPropSet | propSet
renditionType | String型 | getRenditionType

プロパティ詳細

propSetプロパティ
オブジェクトに設定されているレンディションのプロパティ値集合です。

renditionTypeプロパティ
レンディションタイプを表します。

以降，DbjRenditionInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.16.1　getRenditionType（レンディションタイプの取得）

3.16.2　propSet（レンディションのプロパティ値集合の取得）

3.16.1　getRenditionType（レンディションタイプの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

レンディションタイプを取得します。

(2)　形式

String getRenditionType()

(3)　引数

なし

(4)　戻り値

renditionTypeプロパティ

(5)　例外

なし

3.16.2　propSet（レンディションのプロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

レンディションのプロパティ値集合を取得します。

取得するプロパティ値集合の各要素は，プロパティ値の参照です。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

propSetプロパティ（DbjPropSetインターフェース）

(5)　例外

なし

3.17　DbjRenditionListインターフェース

DbjRenditionListインターフェースは，レンディション情報のリストを扱うインターフェースです。リストの要素であるレンディション情報（DbjRenditionInfoインターフェース）を取得するメソッドを提供します。また，各レンディション情報からレンディションタイプのリストを取得するメソッドも提供します。

直接のスーパーインターフェース

java.util.List
DbjRenditionListインターフェースはjava.util.Listインターフェースを継承します。リスト中の各要素はDbjRenditionInfoインターフェースです。

以降，DbjRenditionListインターフェースのメソッドについて説明します。

＜この節の構成＞

3.17.1　getRenditionInfo（レンディション情報の取得）

3.17.2　getRenditionTypeList（レンディションタイプのリストの取得）

3.17.1　getRenditionInfo（レンディション情報の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定した要素のDbjRenditionInfoインターフェースを取得します。

指定した要素はjava.util.List#getメソッドでも取得できますが，このgetRenditionInfoメソッドでは，ユーザアプリケーションプログラムがダウンキャストしないで要素を取得できます。

(2)　形式

DbjRenditionInfo getRenditionInfo(
    int     index
)

(3)　引数

index（入力）

レンディション情報を取得する要素のインデクスを指定します。

0から始まるインデクスで指定してください。

(4)　戻り値

指定した要素のレンディション情報（DbjRenditionInfoインターフェース）

(5)　例外

ClassCastException

要素がDbjRenditionInfoインターフェースでなかった場合

IndexOutOfBoundsException

インデクスが不正の場合

3.17.2　getRenditionTypeList（レンディションタイプのリストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

オブジェクトが保持するすべての要素のレンディションタイプをList型で取得します。

リストが空の場合は，空リストが返却されます。

(2)　形式

List getRenditionTypeList()

(3)　引数

なし

(4)　戻り値

レンディションタイプのリスト（List型（各要素はString型））

(5)　例外

なし

3.18　DbjResultSetインターフェース

DbjResultSetインターフェースは，検索結果集合を扱うインターフェースです。検索結果集合の情報を扱うメソッド，指定した行または列のデータを取得するメソッド，カーソルを操作するメソッドなどを提供します。

検索結果集合とは，要素にプロパティ値を保持する行と列の2次元データに，メタデータを付けたものです。メタデータとは，列のプロパティ値のデータ型と列名の集合のことです。DbjResultSetインターフェースは，検索結果集合の2次元データを，各行を要素とするリストとして扱います。また，この各行データを，各列の値を要素とするリストとして扱います。

列名をメタデータに含む検索結果集合を名前付き検索結果といい，列名をメタデータに含まない検索結果集合を名前なし検索結果といいます。ユーザアプリケーションプログラムで実行する検索メソッドの形式によって，取得する検索結果集合が名前付きか名前なしかが決まります。名前付き検索結果は，検索結果集合をプロパティ値集合にマッピングする際に利用できます。また，列名を指定して名前が重複する列を削除したり，列名の付いていない列だけを削除したりできます。

検索結果集合に対するデータのアクセスには，カーソルを使用します。このカーソルの初期位置は，検索結果集合の先頭行の前です。したがって，ある行のデータを取得する際には，まずDbjResultSet#nextメソッドなどを実行して，カーソルを移動する必要があります。

直接のスーパーインターフェース

java.util.List

以降，DbjResultSetインターフェースのメソッドについて説明します。

＜この節の構成＞

3.18.1　absolute（カーソルの絶対指定行への移動）

3.18.2　afterLast（カーソルの最終行の後ろへの移動）

3.18.3　beforeFirst（カーソルの先頭行の前への移動）

3.18.4　distinct（列の重複の排除）

3.18.5　findColumnName（列インデクスの取得）

3.18.6　first（カーソルの先頭行への移動）

3.18.7　getColumnCount（列数の取得）

3.18.8　getColumnMetaName（列名の取得（表名を含む））

3.18.9　getColumnName（列名の取得）

3.18.10　getColumnType（列のデータ型の取得）

3.18.11　getColumnVals（列データの取得）

3.18.12　getIntegerVal（Integer型での列データの取得）

3.18.13　getIntVal（int型での列データの取得）

3.18.14　getObjectRef（データの参照の取得）

3.18.15　getObjectVal（データの取得）

3.18.16　getPropSet（行データをプロパティ値集合として取得）

3.18.17　getRow（カーソル行インデクスの取得）

3.18.18　getRowCount（行数の取得）

3.18.19　getRowVals（行データの取得）

3.18.20　getStringVal（String型での列データの取得）

3.18.21　getTableName（表名の取得）

3.18.22　getVArrayRef（VARRAY型でのデータの参照の取得）

3.18.23　getVArrayVal（VARRAY型でのデータの取得）

3.18.24　isAfterLast（カーソルが最終行の後ろかどうかの判定）

3.18.25　isBeforeFirst（カーソルが先頭行の前かどうかの判定）

3.18.26　isFirst（カーソルが先頭行かどうかの判定）

3.18.27　isLast（カーソルが最終行かどうかの判定）

3.18.28　isNamed（名前付き検索結果かどうかの判定）

3.18.29　isNull（NULL値かどうかの判定）

3.18.30　last（カーソルの最終行への移動）

3.18.31　next（カーソルの次の行への移動）

3.18.32　previous（カーソルの前の行への移動）

3.18.33　reduct（名前なし列の削除）

3.18.34　setColumnMetaName（列名の設定）

3.18.1　absolute（カーソルの絶対指定行への移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを絶対指定行に移動します。

(2)　形式

boolean absolute(
    int     rowIndex
)

(3)　引数

rowIndex（入力）

カーソルの移動先を行インデクスで指定します。

指定できる範囲は，-1～n（nは行数）です。-1は先頭行の前を表し，nは最終行の後ろを表します。つまり，行インデクスは次のように表せます。

-1：先頭行の前

0：先頭行

n-1：最終行

n：最終行の後ろ

(4)　戻り値

true

移動後が有効行です。

false

移動後が有効行ではありません。カーソルは移動していません。

(5)　例外

IndexOutOfBoundsException

行インデクスが範囲を超えた場合

3.18.2　afterLast（カーソルの最終行の後ろへの移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを最終行の後ろに移動します。

(2)　形式

void afterLast()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

3.18.3　beforeFirst（カーソルの先頭行の前への移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを先頭行の前に移動します。

(2)　形式

void beforeFirst()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

3.18.4　distinct（列の重複の排除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

名前付き検索結果から，列名が重複している列を排除します。

なお，列名が重複している列のうち，どの列が残るかは保証できません。

(2)　形式

void distinct()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

IllegalStateException

名前なし検索結果に対してメソッドを実行した場合

3.18.5　findColumnName（列インデクスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合から，指定した列名の列インデクスを取得します。

指定した列名が検索結果集合にない場合は，-1が返却されます。

なお，指定した列名が重複している場合，どの列インデクスを取得するかは保証できません。

(2)　形式

int findColumnName(
    String     columnName
)

(3)　引数

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のインデクスを取得できます。

(4)　戻り値

列インデクス

(5)　例外

なし

3.18.6　first（カーソルの先頭行への移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを先頭行に移動します。

(2)　形式

boolean first()

(3)　引数

なし

(4)　戻り値

true

移動後が先頭行です。

false

検索結果の件数が0件のため，先頭行がありません。カーソルは移動していません。

(5)　例外

なし

3.18.7　getColumnCount（列数の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合が保持する列数を取得します。

検索結果の件数が0件の場合は，0が返却されます。

(2)　形式

int getColumnCount()

(3)　引数

なし

(4)　戻り値

列数

(5)　例外

なし

3.18.8　getColumnMetaName（列名の取得（表名を含む））

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

名前付き検索結果から，指定した列インデクスの列名を取得します。取得する列名は表名を含みます。

名前なし検索結果の場合は，nullが返却されます。検索結果の件数が0件の場合は，メタデータも空となるため，例外がスローされます。

(2)　形式

String getColumnMetaName(
    int     columnIndex
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

(4)　戻り値

表名を含む列名

(5)　例外

IndexOutOfBoundsException

列インデクスが範囲を超えた場合

NullPointerException

検索結果の件数が0件の場合

3.18.9　getColumnName（列名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

名前付き検索結果から，指定した列インデクスの列名を取得します。取得する列名は表名（または相関名）を含みません。

名前なし検索結果の場合は，nullが返却されます。検索結果の件数が0件の場合は，メタデータも空となるため，例外がスローされます。

(2)　形式

String getColumnName(
    int     columnIndex
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

(4)　戻り値

列名

(5)　例外

IndexOutOfBoundsException

列インデクスが範囲を超えた場合

NullPointerException

検索結果の件数が0件の場合

3.18.10　getColumnType（列のデータ型の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合から，指定した列インデクスの列のデータ型を取得します。

検索結果の件数が0件の場合は，メタデータも空となるため，例外がスローされます。

(2)　形式

int getColumnType(
    int     columnIndex
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

(4)　戻り値

列のデータ型が，次に示す定数で返却されます。

DbjDef.DATATYPE_BOOL
BOOL型

DbjDef.DATATYPE_INT
INT型

DbjDef.DATATYPE_STR
STR型

DbjDef.DATATYPE_VARRAY
VARRAY型

(5)　例外

IndexOutOfBoundsException

列インデクスが範囲を超えた場合

NullPointerException

検索結果の件数が0件の場合

3.18.11　getColumnVals（列データの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合から，指定した列データの全行をリストで取得します。取得したListオブジェクトは新規に作成され，Listオブジェクトの各要素は列データ値のコピーとなります。

データを取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを取得するかは保証できません。

(2)　形式

(a)　形式1

List getColumnVals(
    int     columnIndex
)

(b)　形式2

List getColumnVals(
    String     columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のデータを取得できます。

(4)　戻り値

列データのリスト

(5)　例外

IllegalArgumentException

指定した列名がなかった場合

IndexOutOfBoundsException

列インデクスが範囲を超えた場合

3.18.12　getIntegerVal（Integer型での列データの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列データをInteger型で取得します。

列値がNULL値の場合は，nullが返却されます。列値がINT型でない場合は，例外がスローされます。

データを取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを取得するかは保証できません。

(2)　形式

(a)　形式1

Integer getIntegerVal(
    int        columnIndex
)

(b)　形式2

Integer getIntegerVal(
    String     columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のINT型データを取得できます。

(4)　戻り値

列データ（Integer型）

(5)　例外

ClassCastException

列値がINT型でなかった場合

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.13　getIntVal（int型での列データの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列のデータをint型で取得します。

列値がNULL値の場合は，0が返却されます。列値がINT型でない場合は，java.lang.Object#toStringメソッドの実行結果がさらにint型の値に変換されて返却されます。列値がINT型の場合は，そのままjava.langInteger#intValueメソッドの実行結果が返却されます。

データを取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを取得するかは保証できません。

(2)　形式

(a)　形式1

int getIntVal(
    int     columnIndex
)

(b)　形式2

int getIntVal(
    String  columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のデータをint型で取得できます。

(4)　戻り値

列データ（int型）

(5)　例外

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

NumberFormatException

数値変換に失敗した場合

3.18.14　getObjectRef（データの参照の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列のObject型データの値の参照を取得します。列値がNULL値の場合は，nullが返却されます。

データの参照を取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データの参照を取得するかは保証できません。

(2)　形式

(a)　形式1

Object getObjectRef(
    int      columnIndex
)

(b)　形式2

Object getObjectRef(
    String   columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のデータの参照を取得できます。

(4)　戻り値

データ（Object型）

(5)　例外

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.15　getObjectVal（データの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列のObject型データの値のコピーを取得します。列値がNULL値の場合は，nullが返却されます。

データを取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを取得するかは保証できません。

(2)　形式

(a)　形式1

Object getObjectVal(
    int       columnIndex
)

(b)　形式2

Object getObjectVal(
    String    columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のデータ値のコピーを取得できます。

(4)　戻り値

データ（Object型）

(5)　例外

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.16　getPropSet（行データをプロパティ値集合として取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

名前付き検索結果から，指定した行のデータをプロパティ値集合として取得します。取得したプロパティ値集合は新規に作成され，値がコピーされます。取得後のプロパティ値集合のプロパティ名は，列名の「.」（ピリオド）以前の文字列が削除されます。

なお，指定した行のデータのうち，列名がnullの列のデータは取得しません。

形式1，3はカーソル行が対象となり，形式2，4はインデクスで行を指定します。

形式1，2はすべての列が対象となりますが，形式3，4は指定した表名（または相関名）に関連する列名だけを対象とします。なお，形式3，4では，列名が「表名.列名」の形式で設定されている必要があります。

(2)　形式

(a)　形式1

DbjPropSet getPropSet()

(b)　形式2

DbjPropSet getPropSet(
    int       rowIndex
)

(c)　形式3

DbjPropSet getPropSet(
    String    tableName
)

(d)　形式4

DbjPropSet getPropSet(
    String    tableName,
    int       rowIndex
)

(3)　引数

rowIndex（入力）

0から始まる行インデクスを指定します。

tableName（入力）

対象表名を指定します。nullを指定すると，表指定なしとみなされます。

(4)　戻り値

行データ（DbjPropSetインターフェース）

(5)　例外

IllegalStateException

名前付き検索結果でない場合，またはカーソル状態が不正の場合

IndexOutOfBoundsException

行インデクスが不正の場合

3.18.17　getRow（カーソル行インデクスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合から，カーソル行のインデクスを取得します。

(2)　形式

int getRow()

(3)　引数

なし

(4)　戻り値

カーソル行のインデクス

(5)　例外

なし

3.18.18　getRowCount（行数の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合が保持する行数を取得します。

(2)　形式

int getRowCount()

(3)　引数

なし

(4)　戻り値

行数

(5)　例外

なし

3.18.19　getRowVals（行データの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合から，指定した行のデータをリストで取得します。各要素は列データの値となります。取得したリストは新規に作成されます。

形式1はカーソル行のデータを取得し，形式2はインデクスで指定した行のデータを取得します。

(2)　形式

(a)　形式1

List getRowVals()

(b)　形式2

List getRowVals(
    int      rowIndex
)

(3)　引数

rowIndex（入力）

0から始まる行インデクスを指定します。

(4)　戻り値

行データのリスト

(5)　例外

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

行インデクスが不正の場合

3.18.20　getStringVal（String型での列データの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列のデータをString型で取得します。列データがNULL値の場合は，nullが返却されます。列データがSTR型でない場合は，java.lang.Object#toStringメソッドを実行した結果が返却されます。

データを取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを取得するかは保証できません。

(2)　形式

(a)　形式1

String getStringVal(
    int       columnIndex
)

(b)　形式2

String getStringVal(
    String    columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のデータをString型で取得できます。

(4)　戻り値

列データ（String型）

(5)　例外

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.21　getTableName（表名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

名前付き検索結果から，指定した列の表名（または相関名）を取得します。

指定した列の列名が表名を含まない場合は，nullが返却されます。検索結果の件数が0件の場合は，メタデータも空となるため，例外がスローされます。

(2)　形式

String getTableName(
    int     columnIndex
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

(4)　戻り値

表名

(5)　例外

IllegalStateException

検索結果の件数が0件の場合

IndexOutOfBoundsException

列インデクスが範囲を超えた場合

3.18.22　getVArrayRef（VARRAY型でのデータの参照の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列のVARRAY型データの参照を取得します。列値がNULL値の場合は，nullが返却されます。列値がVARRAY型でない場合は，例外がスローされます。

データの参照を取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列のデータの参照を取得するかは保証できません。

(2)　形式

(a)　形式1

DbjVArray getVArrayRef(
    int       columnIndex
)

(b)　形式2

DbjVArray getVArrayRef(
    String    columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のVARRAY型データの参照を取得できます。

(4)　戻り値

VARRAY型データ（DbjVArrayインターフェース）

(5)　例外

ClassCastException

列値がVARRAY型でなかった場合

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.23　getVArrayVal（VARRAY型でのデータの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行から，指定した列のVARRAY型データのコピーを取得します。列データがNULL値の場合は，nullが返却されます。列データがVARRAY型でない場合は，例外がスローされます。

データを取得する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを取得するかは保証できません。

(2)　形式

(a)　形式1

DbjVArray getVArrayVal(
    int       columnIndex
)

(b)　形式2

DbjVArray getVArrayVal(
    String    columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のVARRAY型データのコピーを取得できます。

(4)　戻り値

VARRAY型データ（DbjVArrayインターフェース）

(5)　例外

ClassCastException

列値がVARRAY型でなかった場合

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.24　isAfterLast（カーソルが最終行の後ろかどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルが最終行の後ろかどうかを判定します。

(2)　形式

boolean isAfterLast()

(3)　引数

なし

(4)　戻り値

true

最終行の後ろです。または，検索結果の件数が0件のため最終行がありません。

false

最終行の後ろではありません。

(5)　例外

なし

3.18.25　isBeforeFirst（カーソルが先頭行の前かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルが先頭行の前かどうかを判定します。

(2)　形式

boolean isBeforeFirst()

(3)　引数

なし

(4)　戻り値

true

先頭行の前です。または，検索結果の件数が0件のため先頭行がありません。

false

先頭行の前ではありません。

(5)　例外

なし

3.18.26　isFirst（カーソルが先頭行かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルが先頭行かどうかを判定します。

(2)　形式

boolean isFirst()

(3)　引数

なし

(4)　戻り値

true

先頭行です。

false

先頭行ではありません。

(5)　例外

なし

3.18.27　isLast（カーソルが最終行かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルが最終行かどうかを判定します。

(2)　形式

boolean isLast()

(3)　引数

なし

(4)　戻り値

true

最終行です。

false

最終行ではありません。

(5)　例外

なし

3.18.28　isNamed（名前付き検索結果かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合が名前付き検索結果かどうかを判定します。

(2)　形式

boolean isNamed()

(3)　引数

なし

(4)　戻り値

true

名前付き検索結果です。

false

名前付き検索結果ではありません。名前なし検索結果です。

(5)　例外

なし

3.18.29　isNull（NULL値かどうかの判定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソル行の，指定した列のデータがNULL値かどうかを判定します。

NULL値かどうか判定する列は，列インデクス（形式1）または列名（形式2）で指定します。なお，列名で指定した場合で，その列名が重複しているときは，どの列データを判定するかは保証できません。

(2)　形式

(a)　形式1

boolean isNull(
    int       columnIndex
)

(b)　形式2

boolean isNull(
    String    columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnName（入力）

列名を指定します。nullを指定すると，列名が付いていない列のデータがNULL値かどうかを判定します。

(4)　戻り値

true

NULL値です。

false

NULL値ではありません。

(5)　例外

IllegalArgumentException

指定した列名がなかった場合

IllegalStateException

カーソル状態が不正の場合

IndexOutOfBoundsException

列インデクスが不正の場合

3.18.30　last（カーソルの最終行への移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを最終行に移動します。

(2)　形式

boolean last()

(3)　引数

なし

(4)　戻り値

true

移動後が最終行です。

false

検索結果の件数が0件のため，最終行がありません。カーソルは移動していません。

(5)　例外

なし

3.18.31　next（カーソルの次の行への移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを次の行に移動します。

(2)　形式

boolean next()

(3)　引数

なし

(4)　戻り値

true

移動後，末尾（EOF）を越えていません。有効行です。

false

移動後，末尾（EOF）を越えました。カーソルは移動していません。

(5)　例外

なし

3.18.32　previous（カーソルの前の行への移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合のカーソルを前の行に移動します。

(2)　形式

boolean previous()

(3)　引数

なし

(4)　戻り値

true

移動後が有効行です。

false

移動後が有効行ではありません。カーソルは移動していません。

(5)　例外

なし

3.18.33　reduct（名前なし列の削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

名前付き検索結果の列から，名前の付いていない列（列名がnullの列）を削除します。

(2)　形式

void reduct()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

IllegalStateException

名前なし検索結果に対してメソッドを実行した場合

3.18.34　setColumnMetaName（列名の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索結果集合の，指定した列の列名を設定します。列名には表名（または相関名）を含めてもかまいません。列名は，ほかの列の列名と重複してもかまいませんが，できるだけ重複しないように設定することをお勧めします。

なお，名前なし検索結果に対して一つでも列名を設定すると，検索結果集合は名前付き検索結果となります。また，一度名前付き検索結果となった検索結果集合は，すべての列名をnullに設定しても，名前付き検索結果のままです。つまり，すべての列名がnullである検索結果集合でも，名前付き検索結果の場合があります。

(2)　形式

void setColumnMetaName(
    int        columnIndex,
    String     columnName
)

(3)　引数

columnIndex（入力）

0から始まる列インデクスを指定します。

columnMetaName（入力）

列名を指定します。nullを指定できます。

(4)　戻り値

なし

(5)　例外

IndexOutOfBoundsException

列インデクスが範囲を超えた場合

3.19　DbjSeedDocQParamインターフェース

DbjSeedDocQParamインターフェースは，種文章を表す?パラメタを扱うインターフェースです。

直接のスーパーインターフェース

DbjQParam

3.20　DbjSetDCRLinkInfoインターフェース

DbjSetDCRLinkInfoインターフェースは，DbjObj#Linkメソッドなどで設定する直接型リンクの設定情報を扱うインターフェースです。このインターフェースで扱うオブジェクトのlinkTypeプロパティの値は，常にDbjDef.LINK_DCRとなります。

直接のスーパーインターフェース

DbjSetLinkInfo

3.21　DbjSetLinkInfoインターフェース

DbjSetLinkInfoインターフェースは，DbjObj#Linkメソッドなどで設定するリンク設定情報を扱うインターフェースです。リンク種別およびリンク先オブジェクトを取得，設定するメソッドを提供します。

直接のスーパーインターフェース

java.lang.Cloneable
DbjSetLinkInfoインターフェースは，java.lang.Cloneableインターフェースを継承します。このインターフェースのcloneメソッドは，ディープコピーを実行します。

プロパティ一覧

DbjSetLinkInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-11に示します。

表3-11　DbjSetLinkInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
linkType | int型 | getLinkType | －
propSet | DbjPropSet | PropSet | setPropSet
targetObj | DbjObj | getTargetObj | setTargetObj

（凡例）

－：該当するメソッドがないことを示します。

プロパティ詳細

linkTypeプロパティ
リンク種別を表します。

propSetプロパティ
リンクオブジェクトのプロパティ値集合です。

targetObjプロパティ
リンク先オブジェクトを表します。

以降，DbjSetLinkInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.21.1　getLinkType（リンク種別の取得）

3.21.2　getTargetObj（リンク先オブジェクトの取得）

3.21.3　propSet（リンクオブジェクトのプロパティ値集合の取得）

3.21.4　setPropSet（リンクオブジェクトのプロパティ値集合の設定）

3.21.5　setTargetObj（リンク先オブジェクトの設定）

3.21.1　getLinkType（リンク種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンク種別を取得します。

(2)　形式

int getLinkType()

(3)　引数

なし

(4)　戻り値

リンク種別が，次に示す定数で返却されます。

DbjDef.LINK_DCR
直接型リンク

DbjDef.LINK_RCR
参照型リンク

DbjDef.LINK_VTFIX
構成管理型リンク（構成管理モードはFIXモード）

DbjDef.LINK_VTFLOAT
構成管理型リンク（構成管理モードはFLOATINGモード）

DbjDef.LINK_REL
文書間リンク

(5)　例外

なし

3.21.2　getTargetObj（リンク先オブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンク先オブジェクトを取得します。

(2)　形式

DbjObj getTargetObj()

(3)　引数

なし

(4)　戻り値

targetObjプロパティ（DbjObjインターフェース）

(5)　例外

なし

3.21.3　propSet（リンクオブジェクトのプロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクオブジェクトのプロパティ値集合を取得します。

取得するプロパティ値集合の各要素は，プロパティ値の参照です。なお，値が設定されていなくても，nullは返却されません。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

propSetプロパティ（DbjPropSetインターフェース）

(5)　例外

なし

3.21.4　setPropSet（リンクオブジェクトのプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクオブジェクトのプロパティ値を要素としたプロパティ値集合に，指定したプロパティ値集合の内容をコピーして設定します。

(2)　形式

void setPropSet(
    DbjPropSet     propSet
)

(3)　引数

propSet（入力）

設定するリンクのプロパティ値集合を指定します。nullを指定できます。

(4)　戻り値

なし

(5)　例外

なし

3.21.5　setTargetObj（リンク先オブジェクトの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンク先オブジェクトを設定します。

(2)　形式

void setTargetObj(
    DbjObj     obj
)

(3)　引数

obj（入力）

リンク先となるオブジェクトを指定します。nullを指定できます。

(4)　戻り値

なし

(5)　例外

なし

3.22　DbjSetRCRLinkInfoインターフェース

DbjSetRCRLinkInfoインターフェースは，DbjObj#Linkメソッドなどで設定する参照型リンクの設定情報を扱うインターフェースです。このインターフェースで扱うオブジェクトのlinkTypeプロパティの値は，常にDbjDef.LINK_RCRとなります。

直接のスーパーインターフェース

DbjSetLinkInfo

3.23　DbjSetRelLinkInfoインターフェース

DbjSetRelLinkInfoインターフェースは，DbjObj#Linkメソッドなどで設定する文書間リンクの設定情報を扱うインターフェースです。このインターフェースで扱うオブジェクトのlinkTypeプロパティの値は，常にDbjDef.LINK_RELとなります。

直接のスーパーインターフェース

DbjSetLinkInfo

3.24　DbjSetVTFixLinkInfoインターフェース

DbjSetVTFixLinkInfoインターフェースは，DbjObj#Linkメソッドなどで設定する構成管理型リンク（構成管理モードはFIXモード）の設定情報を扱うインターフェースです。このインターフェースで扱うオブジェクトのlinkTypeプロパティの値は，常にDbjDef.LINK_VTFIXとなります。

直接のスーパーインターフェース

DbjSetVTLinkInfo

3.25　DbjSetVTFloatLinkInfoインターフェース

DbjSetVTFloatLinkInfoインターフェースは，DbjObj#Linkメソッドなどで設定する構成管理型リンク（構成管理モードはFLOATINGモード）の設定情報を扱うインターフェースです。このインターフェースで扱うオブジェクトのlinkTypeプロパティの値は，常にDbjDef.LINK_VTFLOATとなります。

直接のスーパーインターフェース

DbjSetVTLinkInfo

3.26　DbjSetVTLinkInfoインターフェース

DbjSetVTLinkInfoインターフェースは，構成管理型リンクの設定情報を扱うインターフェースのスーパーインターフェースです。

直接のスーパーインターフェース

DbjSetLinkInfo

3.27　DbjStringQParamインターフェース

DbjStringQParamインターフェースは，STR型を表す?パラメタを扱うインターフェースです。

直接のスーパーインターフェース

DbjQParam

3.28　DbjUploadInfoインターフェース

DbjUploadInfoインターフェースは，文書のアップロード情報を扱うインターフェースです。文書のアップロード情報を取得，設定するメソッドを提供します。

直接のスーパーインターフェース

java.lang.Cloneable
DbjUploadInfoインターフェースは，java.lang.Cloneableインターフェースを継承します。このインターフェースのcloneメソッドは，ディープコピーを実行します。

プロパティ一覧

DbjUploadInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-12に示します。

表3-12　DbjUploadInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
filePath | String型 | getFilePath | setFilePath
indexPath | String型 | getIndexPath | setIndexPath
renditionPropSet | DbjPropSet | renditionPropSet | setRenditionPropSet
renditionType | String型 | getRenditionType | setRenditionType
retrievalName | String型 | getRetrievalName | setRetrievalName

プロパティ詳細

filePathプロパティ
登録する文書のローカルパス名を表します。ファイル名を含むフルパスです。
次に示す場合には，このプロパティの値にnullを指定できます。
・DocumentBroker Rendering Optionのレンディション変換を利用してサブレンディションを登録する場合
・マルチレンディションを使用しない文書（サブレンディションを持たない，マスタレンディションだけの文書）を登録する場合※
注※
この場合，登録する文書から全文検索インデクスを作成しません。
初期値はnullです。

indexPathプロパティ
登録する文書の全文検索インデクスを作成するファイルのフルパスを表します。登録する文書がマスタレンディションでない場合は，このプロパティの値は無視されます。
filePathプロパティに指定したファイルから全文検索インデクスを作成する場合は，DbjDef.INDEXPATH_SAMEを指定します。全文検索インデクスを作成しない場合は，nullを指定します。
初期値はnullです。

renditionPropSetプロパティ
登録する文書のレンディションプロパティ値集合です。レンディションプロパティ値集合には，次のプロパティが指定できます。
・dbrProp_RetrievalName（レンディションに登録された文書のファイル名）
・dbrProp_RenditionStatus（レンディションの更新状態）
各レンディションプロパティの値に初期値を設定する場合は，nullを指定します。
初期値は空プロパティ値集合です。

renditionTypeプロパティ
登録する文書のレンディションタイプを表します。設定したレンディションタイプは登録文書オブジェクトのdbrProp_RenditionTypeプロパティに設定されます。
このプロパティ値にnullを設定すると，retrievalNameプロパティの値の拡張子に対応するレンディションタイプが設定されます。retrievalNameプロパティの値もnullの場合には，filePathプロパティの値の拡張子に対応するレンディションタイプが設定されます。この時，拡張子に対応するレンディションタイプは，レンディション定義ファイルの定義内容に従って取得されます。拡張子がレンディション定義ファイルに定義されていない場合は，レンディションタイプとしてnullが設定されます。なお，このプロパティ値にnullを指定して，さらにretrievalNameプロパティおよびfilePathプロパティの値もnullの場合には，レンディションタイプにnullが設定されます。
初期値はnullです。

retrievalNameプロパティ
登録する文書のクライアント側でのオリジナルファイル名を表します。設定したファイル名は登録文書オブジェクトのdbrProp_RetrievalNameプロパティに設定されます。
filePathプロパティに指定したフルパス中のファイル名を設定したい場合は，nullを指定します。
初期値はnullです。

以降，DbjUploadInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.28.1　getFilePath（登録する文書のフルパスの取得）

3.28.2　getIndexPath（全文検索インデクス作成用ファイルのフルパスの取得）

3.28.3　getRenditionType（登録する文書のレンディションタイプの取得）

3.28.4　getRetrievalName（登録する文書のファイル名の取得）

3.28.5　renditionPropSet（レンディションプロパティ値集合の取得）

3.28.6　setFilePath（登録する文書のフルパスの設定）

3.28.7　setIndexPath（全文検索インデクス作成用ファイルのフルパスの設定）

3.28.8　setRenditionPropSet（レンディションプロパティ値集合の設定）

3.28.9　setRenditionType（登録する文書のレンディションタイプの設定）

3.28.10　setRetrievalName（登録する文書のファイル名の設定）

3.28.1　getFilePath（登録する文書のフルパスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書のフルパスを取得します。

(2)　形式

String getFilePath()

(3)　引数

なし

(4)　戻り値

filePathプロパティ

(5)　例外

なし

3.28.2　getIndexPath（全文検索インデクス作成用ファイルのフルパスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索インデクス作成用ファイルのフルパスを取得します。

(2)　形式

String getIndexPath()

(3)　引数

なし

(4)　戻り値

indexPathプロパティ

(5)　例外

なし

3.28.3　getRenditionType（登録する文書のレンディションタイプの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書のレンディションタイプを取得します。

(2)　形式

String getRenditionType()

(3)　引数

なし

(4)　戻り値

renditionTypeプロパティ

(5)　例外

なし

3.28.4　getRetrievalName（登録する文書のファイル名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書のファイル名を取得します。

(2)　形式

String getRetrievalName()

(3)　引数

なし

(4)　戻り値

retrievalNameプロパティ

(5)　例外

なし

3.28.5　renditionPropSet（レンディションプロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

レンディションプロパティ値集合を取得します。

取得するプロパティ値集合の各要素は，プロパティ値の参照です。なお，値が設定されていなくても，nullは返却されません。

(2)　形式

DbjPropSet renditionPropSet()

(3)　引数

なし

(4)　戻り値

renditionPropSetプロパティ（DbjPropSetインターフェース）

(5)　例外

なし

3.28.6　setFilePath（登録する文書のフルパスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書のフルパスを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setFilePath(
    String     filePath
)

(3)　引数

filePath（入力）

登録する文書のフルパスを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.28.7　setIndexPath（全文検索インデクス作成用ファイルのフルパスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索インデクス作成用ファイルのフルパスを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setIndexPath(
    String     indexPath
)

(3)　引数

indexPath（入力）

全文検索インデクス作成用ファイルのフルパスを指定します。

filePathプロパティに指定したファイルから全文検索インデクスを作成したい場合は，DbjDef.INDEXPATH_SAMEを指定します。

全文検索インデクスを作成しない場合は，nullを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.28.8　setRenditionPropSet（レンディションプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

レンディションプロパティ値集合に，指定したプロパティ値集合の内容をコピーして設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setRenditionPropSet(
    DbjPropSet     renditionPropSet
)

(3)　引数

renditionPropSet（入力）

設定するレンディションプロパティ値集合を指定します。

各レンディションプロパティの値に初期値を設定する場合は，nullを指定します。

レンディションプロパティ値集合に指定できるプロパティを次に示します。

dbrProp_RetrievalName

dbrProp_RenditionStatus

(4)　戻り値

なし

(5)　例外

なし

3.28.9　setRenditionType（登録する文書のレンディションタイプの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書のレンディションタイプを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setRenditionType(
    String     renditionType
)

(3)　引数

renditionType（入力）

レンディションタイプを指定します。

このプロパティ値にnullを設定すると，filePathプロパティの値の拡張子に対応するレンディションタイプが自動的に設定されます。

(4)　戻り値

なし

(5)　例外

なし

3.28.10　setRetrievalName（登録する文書のファイル名の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

登録する文書のファイル名を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setRetrievalName(
    String      retrievalName
)

(3)　引数

retrievalName（入力）

登録する文書のファイル名を指定します。

filePathプロパティに指定したフルパス中のファイル名を設定したい場合は，nullを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.29　DbjVArrayインターフェース

DbjVArrayインターフェースは，VARRAY型プロパティの値である可変長配列オブジェクトを扱うインターフェースです。可変長配列オブジェクトの要素を扱うメソッド，可変長配列オブジェクトのプロパティを扱うメソッド，およびプロパティ名を変更するメソッドを提供します。

可変長配列オブジェクトは，プロパティ値集合を要素とするリストオブジェクトで，プロパティとしてメタプロパティを保持しています。可変長配列オブジェクトのメタプロパティとは，その可変長配列オブジェクトが保持するプロパティの，プロパティ名集合を表します。

可変長配列オブジェクトの任意の要素は，そのオブジェクトのメタプロパティが保持するプロパティを必ず保持します。例えば，メタプロパティがプロパティ"A"，"B"，"C"を保持する場合，任意の要素がプロパティ"A"，"B"，"C"を保持します。

また，可変長配列オブジェクトの要素は，メタプロパティが保持していないプロパティを要素ごとに保持できます。例えば，メタプロパティがプロパティ"A"，"B"，"C"を保持する場合，ある要素がプロパティ"A"，"B"，"C"，"X"を保持し，同時に別の要素がプロパティ"A"，"B"，"C"，"Y"，"Z"を保持できます。

メタプロパティとプロパティの整合性について
前述のメタプロパティとプロパティとの整合性は，DbjVArrayインターフェースを使用して可変長配列オブジェクトの要素（プロパティ値集合）を追加する場合に保証されます。
しかし，java.util.Listインターフェースを直接使用して要素を追加した場合は，単に要素が追加されるだけとなるため，整合性は保証されません。

直接のスーパーインターフェース

java.util.List

java.lang.Cloneable
DbjVArrayインターフェースのcloneメソッドは，ディープコピーを実行します。

コーディング例

// ユーザアプリケーションプログラムのコーディング例
Set metaProps = new HashSet();
metaProps.add("mdmProp_Name");
metaProps.add("mdmProp_Number");

DbjVArray varray = dbjfactory.createVArray(metaProps);

DbjPropSet props = dbjfactory.createPropSet();
props.setPropVal("mdmProp_Name", "muraoka");
props.setPropVal("mdmProp_Number", 0);

// 1行目の追加("muraoka", 0)
varray.addPropSet(props);

props.setPropVal("mdmProp_Name", "tanaka");
props.setPropVal("mdmProp_Number", 8);

// 2行目の追加("tanaka", 8)
varray.addPropSet(props);

// 表示
System.out.println("1st display");
for(int i = 0; i < varray.size(); i ++ ) {
System.out.print("[" + i + "]");
System.out.print(varray.propSet(i).getStringVal("mdmProp_Name") + ", ");
System.out.println(varray.propSet(i).getIntVal("mdmProp_Number"));
}

// 1行目のmdmProp_Numberプロパティ更新
props = varray.propSet(0);
props.setPropVal("mdmProp_Number", 7);

// 2行目のmdmPropNameプロパティ更新
varray.propSet(1).setPropVal("mdmProp_Name", "kanie");

// 表示
System.out.println("2nd display");
for(int i = 0; i < varray.size(); i++){
System.out.print("[" + i + "]");
System.out.print(varray.propSet(i).getStringVal("mdmProp_Name") + "， ");
System.out.println(varray.propSet(i).getIntVal("mdmProp_Number"));
}

コーディング例の実行結果

1st display
[0]muraoka, 0
[1]tanaka, 8
2nd display
[0]muraoka, 7
[1]kanie, 8

以降，DbjVArrayインターフェースのメソッドについて説明します。

＜この節の構成＞

3.29.1　addPropSet（プロパティ値集合（行）の追加）

3.29.2　addPropVals（プロパティ値（列）の追加）

3.29.3　changePropName（可変長配列オブジェクトのプロパティ名の変更）

3.29.4　changePropNames（可変長配列オブジェクトのプロパティ名の一括変更）

3.29.5　getPropCount（メタプロパティ数の取得）

3.29.6　getPropNameSet（メタプロパティの取得）

3.29.7　getPropVals（可変長配列オブジェクトのプロパティ値のリストの取得）

3.29.8　propSet（プロパティ値集合の取得）

3.29.9　removeProp（プロパティの削除）

3.29.1　addPropSet（プロパティ値集合（行）の追加）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティ値集合を可変長配列オブジェクトの要素に追加します。

追加する際，メタプロパティに含まれているが指定したプロパティ値集合に含まれていないプロパティには，NULL値が設定されます。一方，指定したプロパティ値集合に含まれているがメタプロパティに含まれていないプロパティは，値がそのまま追加されます。ただし，メタプロパティは変更されません。

(2)　形式

void addPropSet(
    DbjPropSet     propSet
)

(3)　引数

propSet（入力）

プロパティ値集合を指定します。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propSetにnullを指定した場合

3.29.2　addPropVals（プロパティ値（列）の追加）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトに，指定したリストの値をコピーして追加します。指定したプロパティ名がすでに存在していた場合は，そのプロパティの値を，指定したリストの値で上書きします。

指定したリストの要素が可変長配列の要素に対して不足していた場合は，リストの最後の要素が可変長配列オブジェクトの不足分に設定されます。

可変長配列オブジェクトが空の場合に限り，空のプロパティ値を追加できます。

メタプロパティは変更されません。

(2)　形式

void addPropVals(
    String     propName,
    List       vals
)

(3)　引数

propName（入力）

プロパティ名を指定します。

vals（入力）

プロパティ値のListインターフェース（要素は可変長配列の各要素のプロパティ値）を指定します。

(4)　戻り値

なし

(5)　例外

IllegalArgumentException

可変長配列要素が空でないのに空リストを指定した場合

NullPointerException

引数propNameにnullを指定した場合

3.29.3　changePropName（可変長配列オブジェクトのプロパティ名の変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

プロパティ名を変更します。

変更後のプロパティ名が可変長配列オブジェクトにすでに存在していても，例外はスローされません。ただし，プロパティ名が変更前，変更後のどちらになるかは保証できません。

また，変更前として指定したプロパティ名が可変長配列オブジェクトにない場合は，falseが返却されます。

(2)　形式

boolean changePropName(
    String     oldName,
    String     newName
)

(3)　引数

oldName（入力）

変更前のプロパティ名を指定します。

nullを指定した場合は，例外がスローされます。

newName（入力）

変更後のプロパティ名を指定します。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

true

変更されました。

false

変更されませんでした。

(5)　例外

NullPointerException

引数oldNameまたはnewNameにnullを指定した場合

3.29.4　changePropNames（可変長配列オブジェクトのプロパティ名の一括変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したマップの内容に従って，プロパティ名を一括変更します。マップは，要素のキーに変更前のプロパティ名を，要素の値に変更後のプロパティ名を設定します。

変更後のプロパティ名が可変長配列オブジェクトにすでに存在していても，例外はスローされません。ただし，プロパティ名が変更前，変更後のどちらになるかは保証できません。

また，変更前として指定したプロパティ名が可変長配列オブジェクトに存在しなくても，例外はスローされません。

(2)　形式

boolean changePropNames(
    Map      changeMap
)

(3)　引数

changeMap（入力）

変更前と変更後のプロパティ名を設定したマップを指定します。

(4)　戻り値

true

一つ以上変更されました。

false

変更されませんでした。

(5)　例外

NullPointerException

指定したマップの任意のキーまたは値にnullを指定した場合

3.29.5　getPropCount（メタプロパティ数の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトのメタプロパティ数を取得します。メタプロパティが設定されていない場合は，0が返却されます。

(2)　形式

int getPropCount()

(3)　引数

なし

(4)　戻り値

メタプロパティ数

(5)　例外

なし

3.29.6　getPropNameSet（メタプロパティの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトが保持するメタプロパティを取得します。戻り値は新規に作成されて返却されます。

メタプロパティが設定されていない場合は，空オブジェクトが返却されます。

(2)　形式

Set getPropNameSet()

(3)　引数

なし

(4)　戻り値

メタプロパティ（要素がString型のプロパティ名集合）

(5)　例外

なし

3.29.7　getPropVals（可変長配列オブジェクトのプロパティ値のリストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトから，指定したプロパティの値のコピーをリストで取得し，そのインターフェースを取得します。

可変長配列オブジェクトの要素が空の場合は，空のListインターフェースを取得します。指定したプロパティ名がない場合は，nullが返却されます。

(2)　形式

List getPropVals(
    String     propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。プロパティ名にnullを指定した場合は，例外がスローされます。

(4)　戻り値

プロパティ値のリストまたはnull

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.29.8　propSet（プロパティ値集合の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトから，指定した行のデータをプロパティ値集合として取得します。

(2)　形式

DbjPropSet propSet(
    int     rowIndex
)

(3)　引数

rowIndex（入力）

0から始まる行インデクスを指定します。

指定できる範囲は，0～n-1（nは行数）です。

(4)　戻り値

プロパティ値集合の参照（DbjPropSetインターフェース）

(5)　例外

IndexOutOfBoundsException

行インデクスが範囲を超えた場合

3.29.9　removeProp（プロパティの削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

可変長配列オブジェクトから，指定したプロパティを削除します。

指定したプロパティがメタプロパティに含まれている場合は，メタプロパティからも指定したプロパティを削除します。

(2)　形式

void removeProp(
    String     propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

(4)　戻り値

なし

(5)　例外

NullPointerException

引数propNameにnullを指定した場合

3.30　DbjXmlUploadInfoインターフェース

DbjXmlUploadInfoインターフェースは，XML文書のアップロード情報を扱うインターフェースです。登録するXML文書の情報およびXMLプロパティマッピングについての情報を取得，設定するメソッドなどを提供します。

XML文書のアップロード情報は，次のメソッドの引数に指定できます。

DbjObj#uploadContentsメソッド

DbjDocSpace#createDocumentメソッド

DbjDocSpace#createVrDocumentメソッド

これらのメソッドを実行すると，filePathプロパティに指定したフルパスのコンテンツを基に，XMLプロパティマッピング機能およびXMLインデクスデータ作成機能が実行されます。このとき，XML文書の構文解析結果がparseMessageプロパティに設定されます。

なお，登録するXML文書がサブレンディションの場合，このインターフェースで扱う情報は無視され，スーパーインターフェースであるDbjUploadInfoインターフェースで扱う情報だけが有効となります。

また，XML文書のアップロード情報はDbjObj#addRenditionメソッドの引数にも指定できますが，この場合も，スーパーインターフェースであるDbjUploadInfoインターフェースで扱う情報だけが有効となります。

直接のスーパーインターフェース

DbjUploadInfo

プロパティ一覧

DbjXmlUploadInfoインターフェースで扱うプロパティの一覧と，各プロパティに対するgetterメソッドおよびsetterメソッドを表3-13に示します。

表3-13　DbjXmlUploadInfoインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド | setterメソッド
filterFilePath | String型 | getFilterFilePath | setFilterFilePath
indexType | int型 | getIndexType | setIndexType
mappingId | String型 | getMappingId | setMappingId
parseLevel | int型 | getParseLevel | setParseLevel
parseMessage | String型 | getParseMessage | clearParseMessage※

注※　構文解析結果メッセージをクリアするメソッドです。

プロパティ詳細

filterFilePathプロパティ
全文検索インデクス作成時に使用するフィルタリング定義ファイルのフルパスです。
このプロパティ値にnullを設定した場合で，かつデフォルトのファイルが存在しないときは，フィルタリング定義ファイルを使用しないで処理を実行します。
初期値はnullです。
なお，このプロパティ値は，登録するXML文書がマスタレンディションの場合にだけ有効です。

indexTypeプロパティ
XML文書から作成する全文検索インデクスの種別です。
初期値はDbjDef.INDEXTYPE_NOTHING（全文検索インデクスを作成しない）です。
なお，このプロパティ値は，登録するXML文書がマスタレンディションの場合にだけ有効です。

mappingIdプロパティ
XMLプロパティマッピングのマッピング定義名です。
XMLプロパティマッピング機能を実行しない場合は，nullを指定します。
初期値はnullです。

parseLevelプロパティ
XML文書の構文解析レベルです。
初期値はDbjDef.XMLPARSE_NO_EXTERNAL_ENTITIES（DTDの解析をしないで外部エンティティを無視）です。

parseMessageプロパティ
XML文書の構文解析結果メッセージが設定されます。解析エラーの場合は例外がスローされるので，このプロパティに設定されるメッセージはワーニング（警告）メッセージだけです。ワーニングがなかった場合，このプロパティ値はnullとなります。
初期値はnullです。

DbjUploadInfoインターフェースから継承するプロパティ詳細

filePathプロパティ
登録するXML文書のローカルパス名を表します。ファイル名を含むフルパス名です。
プロパティマッピング機能を実行しない場合，または全文検索インデクスを作成しない場合は，このプロパティ値にnullを指定できます。

indexPathプロパティ
XML文書のアップロード情報オブジェクト（DbjXmlUploadInfoオブジェクト）では，このプロパティは無効です。常にnullが設定されます。

renditionPropSetプロパティ
登録するXML文書のレンディションプロパティ値集合です。

renditionTypeプロパティ
登録するXML文書のレンディションタイプを表します。

retrievalNameプロパティ
登録するXML文書のクライアント側でのオリジナルファイル名を表します。

以降，DbjXmlUploadInfoインターフェースのメソッドについて説明します。

＜この節の構成＞

3.30.1　clearParseMessage（構文解析結果メッセージのクリア）

3.30.2　getFilterFilePath（フィルタリング定義ファイルのフルパスの取得）

3.30.3　getIndexType（全文検索インデクスの種別の取得）

3.30.4　getMappingId（マッピング定義名の取得）

3.30.5　getParseLevel（構文解析レベルの取得）

3.30.6　getParseMessage（構文解析結果メッセージの取得）

3.30.7　setFilterFilePath（フィルタリング定義ファイルのフルパスの設定）

3.30.8　setIndexType（全文検索インデクスの種別の設定）

3.30.9　setMappingId（マッピング定義名の設定）

3.30.10　setParseLevel（構文解析レベルの設定）

3.30.1　clearParseMessage（構文解析結果メッセージのクリア）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書の構文解析結果メッセージをクリアします。具体的には，parseMessageプロパティの値にnullを設定します。

(2)　形式

void clearParseMessage()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

3.30.2　getFilterFilePath（フィルタリング定義ファイルのフルパスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索インデクス作成時に使用するフィルタリング定義ファイルのフルパスを取得します。

(2)　形式

String getFilterFilePath()

(3)　引数

なし

(4)　戻り値

filterFilePathプロパティ

(5)　例外

なし

3.30.3　getIndexType（全文検索インデクスの種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書から作成する全文検索インデクスの種別を取得します。

(2)　形式

int getIndexType()

(3)　引数

なし

(4)　戻り値

全文検索インデクスの種別が，次に示す定数で返却されます。

DbjDef.INDEXTYPE_NOTHING
全文検索インデクスを作成しません。インデクスデータは出力されません。

DbjDef.INDEXTYPE_PLAIN
構造指定検索なしの全文検索インデクスを作成します。プレーンテキスト形式のインデクスデータが出力されます。

DbjDef.INDEXTYPE_STRUCTURED
構造指定検索用の全文検索インデクスを作成します。構造指定検索用のインデクスデータ（ESIS-B形式のデータ）が出力されます。

(5)　例外

なし

3.30.4　getMappingId（マッピング定義名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XMLプロパティマッピングのマッピング定義名を取得します。

(2)　形式

String getMappingId()

(3)　引数

なし

(4)　戻り値

mappingIdプロパティ

(5)　例外

なし

3.30.5　getParseLevel（構文解析レベルの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書の構文解析レベルを取得します。

(2)　形式

int getParseLevel()

(3)　引数

なし

(4)　戻り値

構文解析レベルが，次に示す定数で返却されます。

DbjDef.XMLPARSE_NO_EXTERNAL_ENTITIES
DTDの解析をしないで，外部エンティティは無視します。

DbjDef.XMLPARSE_WITH_EXTERNAL_ENTITIES
DTDを含めた構文解析をして外部エンティティを読み込みますが，検証は実行しません。

DbjDef.XMLPARSE_VALIDATE
DTDを使用して検証を実行します。

(5)　例外

なし

3.30.6　getParseMessage（構文解析結果メッセージの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書の構文解析結果メッセージを取得します。

(2)　形式

String getParseMessage()

(3)　引数

なし

(4)　戻り値

parseMessageプロパティ

(5)　例外

なし

3.30.7　setFilterFilePath（フィルタリング定義ファイルのフルパスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

全文検索インデクス作成時に使用するフィルタリング定義ファイルのフルパスを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setFilterFilePath(
    String     filterFilePath
)

(3)　引数

filterFilePath（入力）

フィルタリング定義ファイルのフルパスを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.30.8　setIndexType（全文検索インデクスの種別の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

作成する全文検索インデクスの種別を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setIndexType(
    int     indexType
)

(3)　引数

indexType（入力）

全文検索インデクスの種別を指定します。次に示す定数のどれかを指定できます。

DbjDef.INDEXTYPE_NOTHING
全文検索インデクスを作成しません。インデクスデータは出力されません。

DbjDef.INDEXTYPE_PLAIN
構造指定検索なしの全文検索インデクスを作成します。プレーンテキスト形式のインデクスデータが出力されます。

DbjDef.INDEXTYPE_STRUCTURED
構造指定検索用の全文検索インデクスを作成します。構造指定検索用のインデクスデータ（ESIS-B形式のデータ）が出力されます。

(4)　戻り値

なし

(5)　例外

なし

3.30.9　setMappingId（マッピング定義名の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XMLプロパティマッピングのマッピング定義名を設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setMappingId(
    String     mappingId
)

(3)　引数

mappingId（入力）

マッピング定義名を指定します。

XMLプロパティマッピング機能を実行しない場合は，nullを指定します。

(4)　戻り値

なし

(5)　例外

なし

3.30.10　setParseLevel（構文解析レベルの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書の構文解析レベルを設定します。

なお，指定した値の妥当性は検証されません。

(2)　形式

void setParseLevel(
    int     parseLevel
)

(3)　引数

parseLevel（入力）

構文解析のレベルを指定します。次に示す定数のどれかを指定できます。

DbjDef.XMLPARSE_NO_EXTERNAL_ENTITIES
DTDの解析をしないで，外部エンティティは無視します。

DbjDef.XMLPARSE_WITH_EXTERNAL_ENTITIES
DTDを含めた構文解析をして外部エンティティを読み込みますが，検証は実行しません。

DbjDef.XMLPARSE_VALIDATE
DTDを使用して検証を実行します。

(4)　戻り値

なし

(5)　例外

なし

4.　文書管理クラス詳細

この章では，文書管理クラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

4.1　DbjDocSpaceインターフェース

4.2　DbjLinkObjインターフェース

4.3　DbjLinkObjListインターフェース

4.4　DbjObjインターフェース

4.5　DbjObjListインターフェース

4.6　DbjSessionインターフェース

4.7　DbjVerObjインターフェース

4.8　DbjVerObjListインターフェース

4.9　DbjXmlTranslatorインターフェース

4.1　DbjDocSpaceインターフェース

DbjDocSpaceインターフェースは，文書空間へのアクセスを扱うインターフェースです。なお，個別の文書空間オブジェクトへのアクセスにはDbjObjインターフェースを使用し，複数の文書空間オブジェクトへのアクセスにはDbjObjListインターフェースを使用します。DbjDocSpaceインターフェースは，特定の文書空間オブジェクトに依存しないメソッド，および新規に文書空間オブジェクトを生成するメソッドを提供します。

文書空間オブジェクトはDbjDocSpaceインターフェースのメソッドで作成できます。個別の文書空間オブジェクトにアクセスする場合は，ProxyオブジェクトのインターフェースをDbjDocSpace#createObjConnectionメソッドまたはDbjDocSpace#createObjListメソッドで取得し，そのインターフェースを使用してアクセスします。

DbjDocSpaceインターフェースは，接続している文書空間のメタ情報にアクセスできます。この場合，DbjDocSpace#getMetaメソッドを使用して文書空間のメタ情報にアクセスするインターフェースを取得できます。また，DbjDocSpaceインターフェースのDbjDocSpace#isAccessControlModeメソッドを利用することで文書空間がアクセス制御モードで動作しているかどうかを調べることができます。

以降，DbjDocSpaceインターフェースのメソッドについて説明します。

＜この節の構成＞

4.1.1　changeSearchACLMode（検索実行時のアクセス制御モードの変更）

4.1.2　createDocument（バージョンなし文書の作成）

4.1.3　createFolder（バージョンなしフォルダの作成）

4.1.4　createIndependentData（独立データの作成）

4.1.5　createLinkObjList（複数のリンクオブジェクトアクセスインターフェースの取得）

4.1.6　createObjConnection（文書空間オブジェクトアクセスインターフェースの取得）

4.1.7　createObjList（複数の文書空間オブジェクトアクセスインターフェースの取得）

4.1.8　createPublicACL（パブリックACLの作成）

4.1.9　createVrDocument（バージョン付き文書の作成）

4.1.10　createVrFolder（バージョン付きフォルダの作成）

4.1.11　executeSearch（検索の実行）

4.1.12　getMeta（文書空間のメタ情報の取得）

4.1.13　getSearchACLMode（検索実行時のアクセス制御モードの取得）

4.1.14　isAccessControlMode（アクセス制御モードの取得）

4.1.15　removeObjects（検索条件を指定したオブジェクトの削除）

4.1.1　changeSearchACLMode（検索実行時のアクセス制御モードの変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

検索（DbjDocSpace#executeSearchメソッド）の実行時のアクセス制御モードを変更します。アクセス制御モードの指定の有無によって，検索の実行時にアクセスできるオブジェクトが異なる場合があります。アクセス制御モードで動作している文書空間に対して検索を実行する場合，このメソッドを実行してアクセス制御モードなしの状態を設定して検索を実行できます。デフォルト値には，DbjDef.WITH_ACLが設定されています。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

void changeSearchACLMode(
     int            aclMode
)

(3)　引数

aclMode（入力）

検索の実行時のアクセス制御モードを指定します。アクセス制御機能を使用している場合だけ有効です。次のどちらかの値を指定します。

DbjDef.WITH_ACL
アクセス制御機能付き検索モードで実行します。このモードの場合，ユーザはアクセス権がないオブジェクトを検索結果として取得できません。

DbjDef.WITHOUT_ACL
アクセス制御機能なし検索（アクセス権を無視した検索）モードで実行します。このモードの場合，ユーザはアクセス権がないオブジェクトでも検索結果として取得できます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlNotSupportedException

アクセス制御モードで動作していない場合

DbjCORBAException

CORBAエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.2　createDocument（バージョンなし文書の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にバージョンなし文書を作成して，指定したリンク元フォルダにリンクを設定します。作成したバージョンなし文書の文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）を取得します。バージョンなし文書を作成する場合にバージョンなし文書を構成するクラス名，およびバージョンなし文書のプロパティの初期値を指定できます。また，リファレンスファイル管理機能を使用したバージョンなし文書を作成する場合は，引数uploadListにDbjReferenceUploadInfoインターフェースを指定します。

dbrProp_RetrievalName（レンディションに登録されたコンテンツのファイル名）プロパティを指定する方法と指定の優先順位を次に示します。

表4-1　dbrProp_RetrievalNameプロパティの指定方法と優先順位

dbrProp_RetrievalNameプロパティの指定方法 | 優先順位
引数uploadListが持つ要素のretrievalNameプロパティに指定 | 1
引数uploadListが持つ要素のrenditionPropSetプロパティにdbrProp_RetrievalNameを指定 | 2
引数propSetにdbrProp_RetrievalNameを指定（マスタレンディションだけ） | 3

上記のいずれも指定しなかった場合，引数uploadListの要素が持つfilePathプロパティに含まれるファイル名を設定します。また，リファレンスファイル管理機能を使用している場合は，entryプロパティに含まれるファイル名を設定します。

(2)　形式

DbjObj createDocument(
     String           className,
     DbjPropSet       propSet,
     List             uploadList,
     List             parentLinkList
)

(3)　引数

className（入力）

作成するバージョンなし文書のクラス名を指定します。dmaClass_DocVersionクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるdmaClass_DocVersionクラスが仮定されます。

propSet（入力）

作成する文書のプロパティの初期値として設定するプロパティ値集合を指定します。プロパティの初期値を指定しない場合はnullを指定します。

uploadList（入力）

要素は，DbjUploadInfoインターフェース，またはそのサブインターフェースです。作成する文書に登録する文書のアップロード情報のリストを指定します。複数の要素を指定するとマルチレンディションになります。アップロードするファイルを指定しない場合はnullを指定します。

parentLinkList（入力）

要素は，DbjSetLinkInfoインターフェースのサブインターフェースです。作成する文書にリンクを設定するリンク元フォルダオブジェクト群およびリンク種別のリストを指定します。フォルダにリンクを設定しない場合はnullを指定します。

(4)　戻り値

作成した文書の文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

ClassCastException

引数parentLinkListの要素がDbjSetLinkInfoインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjIOException

Java クラスライブラリ固有のIOエラーの場合

DbjMasterRenditionNotSetException

マスタレンディションのレンディションタイプが設定されていなかった場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjRenditionCountOutOfRangeException

指定レンディション数が範囲を超えた場合

DbjRenditionTypeDuplicatedException

指定レンディションタイプが重複していた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

DbjXmlParseException

XML文書解析エラーの場合

IllegalArgumentException

引数の指定が不正の場合

NullPointerException

値が必要な引数がnullの場合

4.1.3　createFolder（バージョンなしフォルダの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にバージョンなしフォルダを作成し，指定したリンク元フォルダにリンクを設定します。作成したバージョンなしフォルダの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）を取得します。バージョンなしフォルダを作成する場合にバージョンなしフォルダを構成するクラス名，およびバージョンなしフォルダのプロパティの初期値を指定できます。

(2)　形式

DbjObj createFolder(
     String      className,
     DbjPropSet  propSet,
     List        parentLinkList
)

(3)　引数

className（入力）

作成するバージョンなしフォルダのクラス名を指定します。edmClass_ContainerVersionクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるedmClass_ContainerVersionクラスが仮定されます。

propSet（入力）

作成するバージョンなしフォルダのプロパティの初期値として設定するプロパティ値集合を指定します。プロパティの初期値を指定しない場合はnullを指定します。

parentLinkList（入力）

要素は，DbjSetLinkInfoインターフェースのサブインターフェースです。作成するバージョンなしフォルダにリンクを設定するリンク元フォルダオブジェクト群のリストを指定します。フォルダにリンクを設定しない場合はnullを指定します。

(4)　戻り値

作成したバージョンなしフォルダの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

ClassCastException

引数parentLinkListの要素がDbjSetLinkInfoインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.4　createIndependentData（独立データの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間に独立データを作成します。作成した独立データの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）を取得します。独立データを作成する場合に独立データを構成するクラス名，および独立データのプロパティの初期値を指定できます。

(2)　形式

DbjObj createIndependentData(
     String       className,
     DbjPropSet   propSet
)

(3)　引数

className（入力）

作成する独立データのクラス名を指定します。edmClass_IndependentPersistenceクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるedmClass_IndependentPersistenceクラスが仮定されます。

propSet（入力）

作成する独立データのプロパティの初期値として設定するプロパティ値集合を指定します。プロパティの初期値を指定しない場合はnullを指定します。

(4)　戻り値

作成した独立データの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.5　createLinkObjList（複数のリンクオブジェクトアクセスインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

複数のリンクオブジェクトにアクセスするインターフェース（DbjLinkObjListインターフェース）を取得します。このインターフェースを実装するオブジェクトは，要素をDbjLinkObjインターフェースとするリストオブジェクトです。ユーザアプリケーションプログラムは，このインターフェースを使用して，複数のリンクオブジェクトに対して一括してアクセスできます。

形式１では，要素数が０の空のリストオブジェクトである複数のリンクオブジェクトアクセスインターフェースを取得します。形式２では，要素がDbjLinkObjインターフェースであるコレクションインターフェースを引数（srcObjs）に指定します。各要素（DbjLinkObjインターフェース）は，リストオブジェクトの要素として設定されます。

(2)　形式

(a)　形式1

DbjLinkObjList createLinkObjList()

(b)　形式2

DbjLinkObjList createLinkObjList(
     Collection      srcObjs
)

(3)　引数

srcObjs（入力）

要素がDbjLinkObjインターフェースのコレクションインターフェースを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

複数のリンクオブジェクトアクセスインターフェース（DbjLinkObjListインターフェース）

(5)　例外

ClassCastException

引数srcObjsの要素がDbjObjインターフェース以外の場合

NullPointerException

引数srcObjsがnullの場合

4.1.6　createObjConnection（文書空間オブジェクトアクセスインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定した文書空間オブジェクトにアクセスするインターフェース（DbjObjインターフェース）を取得します。アクセス対象の文書空間オブジェクトをOIIDで指定します。なお，OIIDの妥当性は検証されません。

このメソッドによって文書空間オブジェクトにアクセスするためのProxyオブジェクトを作成して，そのインターフェース（DbjObjインターフェース）を取得します。ユーザアプリケーションプログラムは，取得したDbjObjインターフェースを使用して対象の文書空間オブジェクトにアクセスします。ただし，このメソッドでは実際に文書空間オブジェクトに接続しません。

(2)　形式

DbjObj createObjConnection(
     String      oiid
)

(3)　引数

oiid（入力）

アクセス対象の文書空間オブジェクトのOIIDを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

NullPointerException

引数oiidがnullの場合

4.1.7　createObjList（複数の文書空間オブジェクトアクセスインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

複数の文書空間オブジェクトにアクセスするインターフェース（DbjObjListインターフェース）を取得します。このインターフェースを実装するオブジェクトは，要素をDbjObjインターフェースとするリストオブジェクトです。ユーザアプリケーションプログラムは，このインターフェースを使用して複数の文書空間オブジェクトに対して一括してアクセスできます。

形式１では，要素数が０の空のリストオブジェクトである複数文書空間オブジェクトにアクセスするインターフェースを取得します。取得後，ユーザがList#addメソッドによって要素を追加して使用します。形式２では，要素がDbjObjインターフェースであるコレクションインターフェースを指定します。各要素（DbjObjインターフェース）は，リストオブジェクトの要素として設定されます。

形式３および形式４では，リストオブジェクトの各要素を検索結果集合の各行からリストオブジェクトの要素にマッピングして複数文書空間オブジェクトアクセスインターフェースを取得します。形式３では，OIIDの入っている列を列インデクスで指定します。形式４では，OIIDの入っている列を列名で指定します。さらに，検索結果集合で名前の付いている列（列名がnull以外のもの）は，各要素のProxyオブジェクトのプロパティとして設定されます。名前なし検索結果集合を指定すると，列名はすべてnullになります。よって，要素のProxyオブジェクトは，すべてのプロパティは保持しません。また，OIIDをプロパティとして指定した列は，対象外になります。形式３および形式４のtableNameにnullを指定すると，列名から表名（または相関名）部分が除かれた値がプロパティ名として設定されます。tableNameにnull以外を指定すると，指定した表名（または相関名）を含む列名のプロパティだけが対象になります。

(2)　形式

(a)　形式1

DbjObjList createObjList()

(b)　形式2

DbjObjList createObjList(
    Collection          srcObjs
)

(c)　形式3

DbjObjList createObjList(
    DbjResultSet        result,
    int                 columnIndexOfOiid,
    String              tableName
)

(d)　形式4

DbjObjList createObjList(
    DbjResultSet         result,
    String               columnNameOfOiid,
    String               tableName
)

(3)　引数

srcObjs（入力）

要素がDbjObjインターフェースのコレクションインターフェースを指定します。nullを指定すると例外がスローされます。

result（入力）

検索結果集合のDbjResultSetインターフェースを指定します。nullを指定すると例外がスローされます。

columnIndexOfOiid（入力）

検索結果集合のうち，OIIDを表す列インデクスを指定します。

columnNameOfOiid（入力）

検索結果集合のうち，OIIDを表す列名を指定します。nullを指定すると例外がスローされます。

tableName（入力）

表名（または相関名）を指定します。

(4)　戻り値

複数の文書空間オブジェクトアクセスインターフェース（DbjObjListインターフェース）

(5)　例外

ClassCastException

引数srcObjsの要素がDbjObjインターフェース以外の場合

IndexOutOfBoundsException

引数columnIndexOfOiidが範囲外の場合

NullPointerException

引数srcObjs，result，またはcolumnNameOfOiidがnullの場合

4.1.8　createPublicACL（パブリックACLの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にパブリックACLを作成します。作成したパブリックACLの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）を取得します。パブリックACLの作成時にパブリックACLを構成するクラス名，およびパブリックACLのプロパティの初期値を指定できます。また，パブリックACLをバインドする文書空間オブジェクトも指定できます。

(2)　形式

DbjObj createPublicACL(
    String          className,
    DbjPropSet      propSet,
    List            bindObjectList
)

(3)　引数

className（入力）

作成するパブリックACLのクラス名を指定します。edmClass_PublicACLクラスを指定できます。nullを指定するとデフォルトクラスであるedmClass_PublicACLクラスが仮定されます。

propSet（入力）

作成するパブリックACLのプロパティの初期値として設定するプロパティ値集合を指定します。プロパティの初期値を指定しない場合はnullを指定します。

bindObjectList（入力）

要素はDbjObjインターフェースです。作成するパブリックACLにバインドする文書空間オブジェクトのリストを指定します。バインドする文書空間オブジェクトがない場合はnullを指定します。

(4)　戻り値

作成したパブリックACLの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

ClassCastException

引数bindObjectListの要素がDbjObjインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLAlreadyBoundException

指定パブリックACLはすでにバインドされていた場合

DbjPublicACLNotFoundException

指定パブリックACLは存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.9　createVrDocument（バージョン付き文書の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にバージョン付き文書を作成し，指定したリンク元フォルダにリンクを設定します。作成したバージョン付き文書の文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）を取得します。バージョン付き文書を作成する場合にバージョン付き文書を構成するクラス名，およびバージョン付き文書のプロパティの初期値を指定できます。また，リファレンスファイル管理機能を使用したバージョン付き文書オブジェクトを作成する場合は，引数uploadListにDbjReferenceUploadInfoインターフェースを指定します。

dbrProp_RetrievalName（レンディションに登録されたコンテンツのファイル名）プロパティを指定する方法と指定の優先順位を次に示します。

表4-2　dbrProp_RetrievalNameプロパティの指定方法と優先順位

dbrProp_RetrievalNameプロパティの指定方法 | 優先順位
引数uploadListが持つ要素のretrievalNameプロパティに指定 | 1
引数uploadListが持つ要素のrenditionPropSetプロパティのdbrProp_RetrievalNameに指定 | 2
引数propSetにバージョニングオブジェクトのプロパティとしてdbrProp_RetrievalNameを指定（マスタレンディションだけ） | 3
引数propSetにバージョンオブジェクトのプロパティとしてdbrProp_RetrievalNameを指定（マスタレンディションだけ） | 4

上記のいずれも指定しなかった場合，引数uploadListの要素が持つfilePathプロパティに含まれるファイル名を設定します。また，リファレンスファイル管理機能を使用している場合は，entryプロパティに含まれるファイル名を設定します。

(2)　形式

DbjObj createVrDocument(
    String         classNameVersioning,
    String         classNameVersion,
    DbjPropSet     propSet,
    List           uploadList,
    List           parentLinkList
)

(3)　引数

classNameVersioning（入力）

作成するバージョン付き文書のバージョニングオブジェクトのクラス名を指定します。dmaClass_ConfigurationHistoryクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるdmaClass_ConfigurationHistoryクラスが仮定されます。

classNameVersion（入力）

作成するバージョン付き文書のバージョンオブジェクトのクラス名を指定します。dmaClass_DocVersionクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるedmClass_VersionTracedDocVersionクラスが仮定されます。

propSet（入力）

作成するバージョン付き文書のプロパティの初期値として設定するプロパティ値集合を指定します。バージョニングオブジェクトとバージョンオブジェクト（カレントバージョン）のプロパティを同時に設定できます。プロパティの初期値を指定しない場合はnullを指定します。

uploadList（入力）

要素は，DbjUploadInfoインターフェースまたはそのサブインターフェースです。作成するバージョン付き文書に登録するファイル情報（アップロード情報）のリストを指定します。複数の要素を指定するとマルチレンディションになります。アップロードするファイルを指定しない場合はnullを指定します。

parentLinkList（入力）

要素は，DbjSetLinkInfoインターフェースのサブインターフェースです。作成するバージョン付き文書にリンクを設定するリンク元フォルダオブジェクト群とリンク種別のリストを指定します。フォルダにリンクを設定しない場合はnullを指定します。

(4)　戻り値

作成したバージョン付き文書の文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

ClassCastException

引数parentLinkListの要素がDbjSetLinkInfoインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjIOException

Java クラスライブラリ固有のIOエラーの場合

DbjMasterRenditionNotSetException

マスタレンディションのレンディションタイプが設定されていなかった場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjRenditionCountOutOfRangeException

指定レンディション数が範囲を超えた場合

DbjRenditionTypeDuplicatedException

指定レンディションタイプが重複していた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

DbjXmlParseException

XML文書解析エラーの場合

IllegalArgumentException

引数の指定が不正の場合

NullPointerException

値が必要な引数がnullの場合

4.1.10　createVrFolder（バージョン付きフォルダの作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にバージョン付きフォルダを作成し，指定したリンク元フォルダにリンクを設定します。作成したバージョン付きフォルダの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）を取得します。バージョン付きフォルダを作成する場合にバージョン付きフォルダを構成するクラス名，およびバージョン付きフォルダのプロパティの初期値を指定できます。

(2)　形式

DbjObj createVrFolder(
    String         classNameVersioning,
    String         classNameVersion,
    DbjPropSet     propSet,
    List           parentLinkList
)

(3)　引数

classNameVersioning（入力）

作成するバージョン付きフォルダのバージョニングオブジェクトのクラス名を指定します。dmaClass_ConfigurationHistoryクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるdmaClass_ConfigurationHistoryクラスが仮定されます。

classNameVersion（入力）

作成するバージョン付きフォルダのバージョンオブジェクトのクラス名を指定します。edmClass_ContainerVersionクラス，またはそのサブクラスのクラス名を指定できます。nullを指定するとデフォルトクラスであるedmClass_ContainerVersionクラスが仮定されます。

propSet（入力）

作成するバージョン付きフォルダのプロパティの初期値として設定するプロパティ値集合を指定します。バージョニングオブジェクトとバージョンオブジェクト（カレントバージョン）のプロパティを同時に設定できます。プロパティの初期値を指定しない場合はnullを指定します。

parentLinkList（入力）

要素はDbjSetLinkInfoインターフェースのサブインターフェースです。作成するバージョン付きフォルダにリンクを設定するリンク元フォルダオブジェクト群とリンク種別のリストを指定します。フォルダにリンクを設定しない場合はnullを指定します。

(4)　戻り値

作成したバージョン付きフォルダの文書空間オブジェクトアクセスインターフェース（DbjObjインターフェース）

(5)　例外

ClassCastException

引数parentLinkListの要素がDbjSetLinkInfoインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.11　executeSearch（検索の実行）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間に対してedmSQL文による検索を実行し，検索結果集合オブジェクトインターフェース（DbjResultSetインターフェース）を取得します。

形式1および形式2では，名前なし検索結果集合を取得します。

形式3および形式4では，名前付き検索結果集合を取得します。

形式2および形式4では，ロック種別を指定できます。形式1および形式3では，ロックなし指定（DbjDef.LOCK_NONE指定）に相当します。

形式3および形式4の引数（eqlStatement）には，SELECT句の項目部分に「$_」を使用して記述します。例えば，select $_ from mdmClass_Folder_cのように指定します。また，引数（selectItems）に指定した要素は，「,」（コンマ）で区切られて「$_」に置き換えられます。検索結果集合の列名は，selectItemsで指定した要素になります。SELECT句の項目指定部分は，「$_」だけ使用できます。例えば，select A,$_ from ...と指定すると例外がスローされます。なお，形式３および形式４では，取得される列数とselectItemsの要素数が不一致の場合，例外がスローされます。

(2)　形式

(a)　形式1

DbjResultSet executeSearch(
    String               eqlStatement,
    List                 qParamList,
    DbjFetchInfo         fetchInfo
)

(b)　形式2

DbjResultSet executeSearch(
    String               eqlStatement,
    List                 qParamList,
    DbjFetchInfo         fetchInfo,
    int                  lockType
)

(c)　形式3

DbjResultSet executeSearch(
    List                 selectItems,
    String               eqlStatement,
    List                 qParamList,
    DbjFetchInfo         fetchInfo
)

(d)　形式4

DbjResultSet executeSearch(
    List                 selectItems,
    String               eqlStatement,
    List                 qParamList,
    DbjFetchInfo         fetchInfo,
    int                  lockType
)

(3)　引数

selectItems（入力）

要素のデータ型はString型です。SELECT句に指定する項目のリストを指定します。名前付き検索結果集合の列名になります。nullを指定すると例外がスローされます。

eqlStatement（入力）

edmSQL文を指定します。nullを指定すると例外がスローされます。

qParamList（入力）

?パラメタの値を表します。要素は，DbjQParamインターフェースのサブクラスのリストを指定します。NULL値の場合は，要素の値にnullを指定します。?パラメタの指定がない場合は，nullを指定します。

fetchInfo（入出力）

検索結果取得情報の条件を指定します。全件を取得する場合，またはキャッシュ検索をしない場合はnullを指定します。キャッシュ検索をすると，cacheKeyプロパティとcacheTotalプロパティが設定されます。全件を取得しない場合，maxFetchCountプロパティに指定されている件数を取得した後に，comparatorプロパティに指定したコンパレータによりソートされます。そのため，全件を取得する場合と，maxFetchCountプロパティを指定して検索した場合を比較すると，comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

lockType（入力）

検索結果集合に対して取得するロック種別を指定します。次に示す値のどれかを指定できます。

DbjDef.LOCK_NONE
ロックなし

DbjDef.LOCK_READ
readロック

DbjDef.LOCK_WRITE
writeロック

DbjDef.LOCK_READFORUPDATE
READFORUPDATEロック

(4)　戻り値

検索結果集合オブジェクトインターフェース（DbjResultSetインターフェース）

(5)　例外

DbjAccessControlNotSupportedException

アクセス制御モードに対応していない場合にアクセス制御モードで検索しようとした場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjIllegalCacheStartIndexException

検索結果数より大きい値を引数fetchInfo（DbjFetchInfoインターフェース）のstartIndexプロパティに指定した場合

IllegalArgumentException

引数が不正の場合

NullPointerException

引数eqlStatementがnullの場合

4.1.12　getMeta（文書空間のメタ情報の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

接続している文書空間のメタ情報を取得します。

(2)　形式

DbjMeta getMeta()

(3)　引数

なし

(4)　戻り値

メタ情報インターフェース（DbjMetaインターフェース）

(5)　例外

なし

4.1.13　getSearchACLMode（検索実行時のアクセス制御モードの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

DbjDocSpace#executeSearchメソッドの実行時のアクセス制御モードを取得します。アクセス制御モードが動作している場合だけ有効です。

(2)　形式

int getSearchACLMode()

(3)　引数

なし

(4)　戻り値

DbjDocSpace#executeSearchメソッドの実行時のアクセス制御モードとして次に示す値が返却されます。

DbjDef.WITH_ACL

アクセス制御機能付き検索を実行します。

DbjDef.WITHOUT_ACL

アクセス制御機能なし検索（アクセス権を無視した検索）を実行します。

(5)　例外

DbjAccessControlNotSupportedException

アクセス制御モードで動作していない場合

DbjCORBAException

CORBAエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.14　isAccessControlMode（アクセス制御モードの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間がアクセス制御モードで実行されているかどうかについての情報を取得します。

(2)　形式

boolean isAccessControlMode()

(3)　引数

なし

(4)　戻り値

true

アクセス制御モードで実行しています。

false

アクセス制御モードで実行していません。

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.1.15　removeObjects（検索条件を指定したオブジェクトの削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間に対してedmSQL文による検索を実行し，検索結果として取得したオブジェクトを削除します。このメソッドは，検索結果集合の１列目を，削除対象のオブジェクトのOIIDとみなします。したがって，指定するedmSQL文の主問い合わせのSELECT句の第一項目には，削除対象とする表のdmaProp_OIIDプロパティ（または削除対象のOIID文字列が設定されているプロパティ）を必ず指定します。

(2)　形式

void removeObjects(
    String      eqlStatement,
    List        qParamList
)

(3)　引数

eqlStatement（入力）

edmSQL文を指定します。nullを指定すると例外がスローされます。

qParamList（入力）

?パラメタの値を表します。要素には，DbjQParamインターフェースのサブクラスのリストを指定します。NULL値の場合は，要素の値にnullを指定します。また，?パラメタの指定がない場合は，nullを指定します。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjAccessControlNotSupportedException

アクセス制御モードに対応していない場合にアクセス制御モードで検索しようとした場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjLastVersionException

最後のバージョンを消そうとした場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数eqlStatementがnullの場合

4.2　DbjLinkObjインターフェース

DbjLinkObjインターフェースは，一つのリンクオブジェクトにアクセスするインターフェースです。

以降，DbjLinkObjインターフェースのメソッドについて説明します。

＜この節の構成＞

4.2.1　changeToVTFix（構成管理型リンクの構成管理モードをFIXモードに変更）

4.2.2　changeToVTFloat（構成管理型リンクの構成管理モードをFLOATINGモードに変更）

4.2.3　getLinkId（リンク識別子の取得）

4.2.4　getLinkType（リンク種別の取得）

4.2.5　getOwnerObj（リンク元オブジェクトの取得）

4.2.6　getTargetObj（リンク先オブジェクトの取得）

4.2.7　propSet（リンクProxyオブジェクトのプロパティ値集合インターフェースの取得）

4.2.8　readProperties（リンクプロパティの取得）

4.2.9　removeObject（リンクオブジェクトの削除）

4.2.10　setPropSet（リンクProxyオブジェクトのプロパティ値集合の設定）

4.2.11　writeProperties（リンクプロパティ値の設定）

4.2.1　changeToVTFix（構成管理型リンクの構成管理モードをFIXモードに変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトが指定した構成管理型リンクの構成管理モードをFIXモードに変更します。

形式１では，アクセス対象のリンクオブジェクトが指定した構成管理型リンクを指定したバージョンのバージョン識別子で固定します。バージョン識別子にnullを指定するとカレントバージョンになります。形式２では，すべての構成管理型リンクを，その時点の状態で固定します。

(2)　形式

(a)　形式1

void changeToVTFix(
    String     fixVersionId
)

(b)　形式2

void changeToVTFix()

(3)　引数

fixVersionId（入力）

構成管理型リンクよって固定するバージョンのバージョン識別子を指定します。nullを指定するとカレントバージョンになります。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.2.2　changeToVTFloat（構成管理型リンクの構成管理モードをFLOATINGモードに変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトが指定した構成管理型リンクの構成管理モードをFLOATINGモードに変更します。

(2)　形式

void changeToVTFloat()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.2.3　getLinkId（リンク識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトのリンク識別子を取得します。

(2)　形式

String getLinkId()

(3)　引数

なし

(4)　戻り値

リンク識別子

(5)　例外

なし

4.2.4　getLinkType（リンク種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトのリンク種別を取得します。

(2)　形式

int getLinkType()

(3)　引数

なし

(4)　戻り値

リンク種別

(5)　例外

なし

4.2.5　getOwnerObj（リンク元オブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトのリンク元オブジェクトを取得します。取得するのは，リンク元オブジェクトのProxyオブジェクトのインターフェース（DbjObjインターフェース）です。

(2)　形式

DbjObj getOwnerObj()

(3)　引数

なし

(4)　戻り値

リンク元オブジェクトのインターフェース（DbjObjインターフェース）

(5)　例外

なし

4.2.6　getTargetObj（リンク先オブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトのリンク先オブジェクトを取得します。取得するのは，リンク先オブジェクトのProxyオブジェクトのインターフェース（DbjObjインターフェース）です。

(2)　形式

DbjObj getTargetObj()

(3)　引数

なし

(4)　戻り値

リンク先オブジェクトのインターフェース（DbjObjインターフェース）

(5)　例外

なし

4.2.7　propSet（リンクProxyオブジェクトのプロパティ値集合インターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのプロパティ値集合インターフェースを取得します。プロパティ値集合インターフェースは，参照権限で取得します。取得したインターフェースを使用して値を設定すると，Proxyオブジェクトのリンクプロパティ値も更新されます。なお，プロパティ値集合が設定されていなくてもnullは返却されません。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

リンクProxyオブジェクトのプロパティ値集合インターフェース（DbjPropSetインターフェース）

(5)　例外

なし

4.2.8　readProperties（リンクプロパティの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトの指定プロパティを，各要素のリンクProxyオブジェクトに読み込みます。

形式１では，リンクProxyオブジェクトの保持しているプロパティ値集合でのすべてのプロパティをリンクオブジェクトから読み込みます。形式２では，読み込み対象のプロパティのコレクションを指定します。

(2)　形式

(a)　形式1

void readProperties()

(b)　形式2

void readProperties(
   Collection       propDefs
)

(3)　引数

propDefs（入力）

要素は，リンクプロパティ名（String型）です。取得するプロパティのプロパティ名のコレクションを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propDefsがnullの場合

4.2.9　removeObject（リンクオブジェクトの削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトを削除して，リンクを解除します。

(2)　形式

boolean removeObject()

(3)　引数

なし

(4)　戻り値

true

リンクオブジェクトが削除されました。

false

リンクオブジェクトが削除されませんでした。この値は，すでにリンクオブジェクトが削除されていた場合に返却されます。

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.2.10　setPropSet（リンクProxyオブジェクトのプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのプロパティ値集合に，指定したプロパティ値集合の内容をコピーして設定します。

(2)　形式

void setPropSet(
    DbjPropSet     propSet
)

(3)　引数

propSet（入力）

設定するプロパティ値集合インターフェースを指定します。nullを指定するとオブジェクトのプロパティ値集合には，空値が仮定されます。

(4)　戻り値

なし

(5)　例外

なし

4.2.11　writeProperties（リンクプロパティ値の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトのアクセス対象のターゲットオブジェクトであるリンクオブジェクトのプロパティを一括して設定します。

形式１では，アクセス対象のターゲットオブジェクトであるリンクオブジェクトのプロパティを，指定したプロパティ値集合で設定します。形式２および形式３では，アクセス対象のターゲットオブジェクトであるリンクオブジェクトのプロパティを，リンクProxyオブジェクトに設定されたプロパティ値集合で設定します。形式３では，リンクProxyオブジェクトに設定されているプロパティのうち，アクセス対象のターゲットオブジェクトであるリンクオブジェクトに反映する対象のプロパティを限定して指定できます。

(2)　形式

(a)　形式1

void writeProperties(
    DbjPropSet     propSet
)

(b)　形式2

void writeProperties()

(c)　形式3

void writeProperties(
    Collection     propdef
)

(3)　引数

propSet（入力）

リンクオブジェクトに設定するリンクプロパティ値集合を指定します。nullを指定すると例外がスローされます。

propDefs（入力）

要素はリンクプロパティ名（String型）です。リンクオブジェクトに設定する対象のリンクプロパティ値のコレクションを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propSet，またはpropDefsがnullの場合

4.3　DbjLinkObjListインターフェース

DbjLinkObjListインターフェースは，DbjLinkObjインターフェースを要素とするリストインターフェースを扱います。

スーパーインターフェース

java.util.List

以降，DbjLinkObjListインターフェースのメソッドについて説明します。

＜この節の構成＞

4.3.1　changeToVTFix（複数の構成管理型リンクの構成管理モードを一括してFIXモードに変更）

4.3.2　changeToVTFloat（複数の構成管理型リンクの構成管理モードを一括してFLOATINGモードに変更）

4.3.3　getLinkIdList（ターゲットリンク識別子プロパティのリストの取得）

4.3.4　getLinkObj（リスト要素のDbjLinkObjインターフェースの取得）

4.3.5　getOwnerObjList（リンク元オブジェクトのリストの取得）

4.3.6　getTargetObjList（リンク先オブジェクトのリストの取得）

4.3.7　readProperties（リンクプロパティ値の一括取得）

4.3.8　removeObjects（リンクオブジェクトの一括削除）

4.3.9　writeProperties（リンクプロパティ値の一括設定）

4.3.1　changeToVTFix（複数の構成管理型リンクの構成管理モードを一括してFIXモードに変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リスト要素のリンクProxyオブジェクトについて，これらのアクセス対象のターゲットオブジェクトであるリンクオブジェクトの構成管理モードを，一括してFIXモードに変更します。なお，リンクProxyオブジェクトのターゲットオブジェクトであるリンクオブジェクトには，構成管理型リンクを指定する必要があります。

(2)　形式

void changeToVTFix()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.3.2　changeToVTFloat（複数の構成管理型リンクの構成管理モードを一括してFLOATINGモードに変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リスト要素のリンクProxyオブジェクトについて，これらのアクセス対象のターゲットオブジェクトであるリンクオブジェクトの構成管理モードを，一括してFLOATINGモードに変更します。なお，リンクProxyオブジェクトのターゲットオブジェクトであるリンクオブジェクトには，構成管理型リンクを指定する必要があります。

(2)　形式

void changeToVTFloat()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.3.3　getLinkIdList（ターゲットリンク識別子プロパティのリストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンクProxyオブジェクトが保持するリスト要素すべてのターゲットリンク識別子プロパティ値をリストで取得します。

(2)　形式

List getLinkIdList()

(3)　引数

なし

(4)　戻り値

ターゲットリンク識別子プロパティ値（String型）のリスト

(5)　例外

ClassCastException

リスト要素がDbjLinkObjインターフェースでなかった場合

4.3.4　getLinkObj（リスト要素のDbjLinkObjインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

インデクスで指定されたリスト要素のDbjLinkObjインターフェースを取得します。

(2)　形式

DbjLinkObj getLinkObj(
    int     index
)

(3)　引数

index（入力）

リスト要素のインデクスを指定します。

(4)　戻り値

リスト要素のDbjLinkObjインターフェース

(5)　例外

ClassCastException

インデクスで指定されたリスト要素がDbjLinkObjインターフェースでなかった場合

IndexOutOfBoundException

引数に指定したリスト要素のインデクスが不正の場合

4.3.5　getOwnerObjList（リンク元オブジェクトのリストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンク元オブジェクトが保持するリスト要素すべてのオーナーオブジェクトのプロパティ値をリストで取得します。

(2)　形式

DbjObjList getOwnerObjList()

(3)　引数

なし

(4)　戻り値

オーナーオブジェクトのプロパティ値のリスト（DbjObjListインターフェース）

(5)　例外

ClassCastException

リスト要素がDbjLinkObjインターフェースでなかった場合

4.3.6　getTargetObjList（リンク先オブジェクトのリストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リンク先オブジェクトが保持するリスト要素すべてのターゲットオブジェクトのプロパティ値をリストで取得します。

(2)　形式

DbjObjList getTargetObjList()

(3)　引数

なし

(4)　戻り値

ターゲットオブジェクトのプロパティ値のリスト（DbjObjListインターフェース）

(5)　例外

ClassCastException

リスト要素がDbjLinkObjインターフェースでなかった場合

4.3.7　readProperties（リンクプロパティ値の一括取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リスト要素のターゲットオブジェクトであるリンクオブジェクトの指定プロパティを各要素のリンクProxyオブジェクトに一括して読み込みます。リストの要素である各DbjLinkObjインターフェースに対して，DbjLinkObj#readPropertiesメソッドを実行します。

形式１では，Proxyオブジェクトの保持しているプロパティ値集合でのすべてのプロパティをターゲットオブジェクトであるリンクオブジェクトの指定プロパティから読み込みます。形式２では，読み込み対象のプロパティのコレクションを指定します。

(2)　形式

(a)　形式1

void readProperties()

(b)　形式2

void readProperties(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はリンクプロパティ名（String型）です。取得するプロパティのプロパティ名のコレクションを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propDefsがnullの場合

4.3.8　removeObjects（リンクオブジェクトの一括削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リストオブジェクト要素のアクセス対象のターゲットオブジェクトであるリンクオブジェクトを一括して削除します。リストの要素である各DbjLinkObjインターフェースに対して，DbjLinkObj#removeObjectメソッドを実行します。

(2)　形式

List removeObjects()

(3)　引数

なし

(4)　戻り値

削除されたリンクオブジェクトのDbjLinkObjインターフェースのリスト

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.3.9　writeProperties（リンクプロパティ値の一括設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リスト要素のアクセス対象のターゲットオブジェクトであるリンクオブジェクトのプロパティを一括して設定します。

形式１では，要素のアクセス対象のターゲットオブジェクトであるリンクオブジェクトのプロパティを，指定したプロパティ値集合で設定します。形式２および形式３では，要素のアクセス対象のターゲットオブジェクトであるリンクオブジェクトのプロパティを，各要素のリンクProxyオブジェクトに設定されたプロパティ値集合で設定します。形式３では，リンクProxyオブジェクトに設定されているプロパティのうち，ターゲットオブジェクトであるリンクオブジェクトに反映するプロパティを限定して指定できます。

(2)　形式

(a)　形式1

void writeProperties(
    DbjPropSet     propSet
)

(b)　形式2

void writeProperties()

(c)　形式3

void writeProperties(
   Collection     propdef
)

(3)　引数

propSet（入力）

リンクオブジェクトに設定するリンクプロパティ値集合を指定します。nullを指定すると例外がスローされます。

propDefs（入力）

要素はリンクプロパティ名（String型）です。リンクオブジェクトに設定する対象のプロパティ値集合を指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propSet，またはpropDefsがnullの場合

4.4　DbjObjインターフェース

DbjObjインターフェースは，一つの文書空間オブジェクトへのアクセスを扱います。このインターフェースは，Proxyオブジェクトを通じて一つの文書空間オブジェクトにアクセスするメソッドを提供します。

以降，DbjObjインターフェースのメソッドについて説明します。

＜この節の構成＞

4.4.1　addRendition（レンディションの追加）

4.4.2　bindPublicACL（パブリックACLのバインド）

4.4.3　cancelCheckOut（バージョン付きオブジェクトのチェックアウトの取り消し）

4.4.4　changeMasterRendition（マスタレンディションの変更）

4.4.5　changeToVTFix（構成管理型リンクの構成管理モードをFIXモードに変更）

4.4.6　changeToVTFloat（構成管理型リンクの構成管理モードをFLOATINGモードに変更）

4.4.7　checkIn（バージョン付きオブジェクトのチェックイン）

4.4.8　checkOut（バージョン付きオブジェクトのチェックアウト）

4.4.9　deleteRendition（レンディションの削除）

4.4.10　deleteVersion（バージョンの削除）

4.4.11　downloadContents（文書のコンテンツのダウンロード）

4.4.12　getBindObjectList（パブリックACLにバインドしている文書空間オブジェクト一覧の取得）

4.4.13　getCheckOutStatus（バージョン付きオブジェクトのチェックアウト状態の取得）

4.4.14　getChildList（フォルダのリンク先オブジェクト（下位オブジェクト）の取得）

4.4.15　getClassName（アクセス対象文書空間オブジェクトを構成するDMAクラス名の取得）

4.4.16　getDCRParent（直接型リンクによるリンク元オブジェクトの取得）

4.4.17　getLockType（Proxyオブジェクトのアクセスロック種別の取得）

4.4.18　getObjType（アクセス対象文書空間オブジェクトのオブジェクト種別の取得）

4.4.19　getOiid（アクセス対象文書空間オブジェクトのOIIDの取得）

4.4.20　getParentList（フォルダのリンク元オブジェクトの取得）

4.4.21　getPublicACLList（バインドしているパブリックACL一覧の取得）

4.4.22　getRelList（文書間リンク一覧の取得）

4.4.23　getRenditionList（レンディション情報一覧の取得）

4.4.24　getTargetVersion（アクセス対象ターゲットバージョンのバージョン識別子の取得）

4.4.25　getVersionId（バージョンオブジェクトのバージョン識別子の取得）

4.4.26　getVersioningInfo（バージョン付きオブジェクトのバージョニングオブジェクトの取得）

4.4.27　getVersionObjList（バージョン付きオブジェクトのバージョン一覧の取得）

4.4.28　link（リンク先オブジェクトとのリンク）

4.4.29　lock（アクセスロック種別の異なる文書空間オブジェクトインターフェースの取得）

4.4.30　move（直接型リンクが設定されている文書空間オブジェクトの移動）

4.4.31　propSet（Proxyオブジェクトのプロパティ値集合インターフェースの取得）

4.4.32　readProperties（文書空間オブジェクトのプロパティ値の読み込み）

4.4.33　removeObject（文書空間オブジェクトの削除）

4.4.34　setPropSet（Proxyオブジェクトのプロパティ値集合の設定）

4.4.35　setTargetVersion（アクセス対象ターゲットバージョンのバージョン識別子の変更）

4.4.36　unbindPublicACL（パブリックACLのアンバインド）

4.4.37　unlink（リンク先オブジェクトとのリンクの解除）

4.4.38　unlinkByLinkId（リンク識別子の指定によるリンク先オブジェクトとのリンクの解除）

4.4.39　uploadContents（文書のコンテンツのアップロード）

4.4.40　writeProperties（文書空間オブジェクトのプロパティ値の設定）

4.4.41　writeRenditionProperties（レンディションプロパティの設定）

4.4.1　addRendition（レンディションの追加）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書にレンディションを追加します。すでに登録されているレンディションが指定された場合は，例外がスローされます。レンディションを追加できるアクセス対象の文書空間オブジェクトは，文書だけです。

(2)　形式

void addRendition(
    List          uploadList
)

(3)　引数

uploadList（入力）

要素は，DbjUploadInfoインターフェースです。文書に登録するレンディションのファイル情報（アップロード情報）のリストを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定レンディションプロパティ値が不正の場合

DbjIOException

Java クラスライブラリ固有のIOエラーの場合

DbjMasterRenditionNotSetException

マスタレンディションのレンディションタイプが設定されていなかった場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjRenditionCountOutOfRangeException

レンディション数が範囲を超えた場合

DbjRenditionTypeDuplicatedException

指定レンディションタイプが重複していた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjXmlParseException

XML文書解析エラーの場合

NullPointerException

引数uploadListがnullの場合

4.4.2　bindPublicACL（パブリックACLのバインド）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトに，指定したパブリックACLをバインドします。ただし，Proxyオブジェクトのアクセス対象の文書空間オブジェクトには，パブリックACLを指定しないでください。

(2)　形式

void bindPublicACL(
    List     publicACLList
)

(3)　引数

publicACLIdList（入力）

要素はDbjObjインターフェースです。各要素には，バインドするパブリックACLのリストを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

ClassCastException

引数publicACLListの要素がDbjObjインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjAccessControlNotSupportedException

アクセス制御機能に対応していない文書空間だった場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLAlreadyBoundException

指定パブリックACLはすでにバインドされていた場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

パブリックACL数が制限を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数publicACLIdListがnullの場合

4.4.3　cancelCheckOut（バージョン付きオブジェクトのチェックアウトの取り消し）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象であるバージョン付きオブジェクトのチェックアウトを取り消します。チェックアウトを取り消すことができるターゲットオブジェクトは，バージョン付きオブジェクトだけです。

形式１および形式２では，取り消しと同時にProxyオブジェクトに設定されているプロパティ値が，カレントバージョンのプロパティに設定されます。形式２では，設定するプロパティを限定できます（指定したプロパティだけが設定対象になります）。形式３では，Proxyオブジェクトのものに関係なく，指定したプロパティ値集合がカレントバージョンのプロパティを対象として設定されます。Proxyオブジェクトのターゲットバージョン識別子のプロパティは，カレントバージョン（null）になります。

(2)　形式

(a)　形式1

void cancelCheckOut()

(b)　形式2

void cancelCheckOut(
    Collection     propDefs
)

(c)　形式3

void cancelCheckOut(
    DbjPropSet     propSet
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。チェックアウトの取り消し後のカレントバージョンを対象としたバージョン付きオブジェクトに設定するProxyオブジェクトのプロパティとして，どのプロパティを設定するかを指定します。nullを指定するとプロパティを設定しません。

propSet（入力）

チェックアウトの取り消し後のカレントバージョンを対象としたバージョン付きオブジェクトに設定するプロパティ値集合を指定します。nullを指定するとプロパティを設定しません。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceCurrentContentNotfoundException

リファレンスファイル管理機能を使用するバージョン付きの文書オブジェクトで，カレントバージョンにコンテンツが存在しなかった場合

DbjFileReferenceMismatchStatusException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作でエラーが発生し，オブジェクトとコンテンツが不整合な状態になった場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjNotCheckOutException

チェックアウトしていなかった場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

NullPointerException

引数propSetがnullの場合

4.4.4　changeMasterRendition（マスタレンディションの変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書のマスタレンディションを，指定したレンディションタイプのレンディションに変更します。マスタレンディションを変更できるターゲットオブジェクトは，文書だけです。

(2)　形式

void changeMasterRendition(
    String       renditionType
)

(3)　引数

renditionType（入力）

マスタレンディションに変更するレンディションタイプを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIsMasterRenditionException

すでにマスタレンディションだった場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjRenditionIsEmptyException

レンディションが空の場合

DbjRenditionNotConvertedException

指定レンディションが変換されていなかった場合

DbjRenditionNotFoundException

指定レンディションが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていない

NullPointerException

引数renditionTypeがnullの場合

4.4.5　changeToVTFix（構成管理型リンクの構成管理モードをFIXモードに変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトが指定した構成管理型リンクの構成管理モードをFIXモードに変更します。

形式１では，構成管理型リンクのリンク識別子を指定したバージョンのバージョン識別子で固定します。この場合，バージョン識別子にnullを指定するとカレントバージョンになります。形式２では，変更するリンクのリンク識別子および固定するバージョンのバージョン識別子をマップで指定して固定します。要素のキーがリンク識別子となり，その値がバージョン識別子になります。この場合，バージョン識別子にnullを指定するとカレントバージョンになります。形式３では，Proxyオブジェクトのターゲットオブジェクトのすべての構成管理型リンクを，その時点の状態で固定します。

(2)　形式

(a)　形式1

void changeToVTFix(
    String     linkId,
    String     fixVersionId
)

(b)　形式2

void changeToVTFix(
    Map     changeMap
)

(c)　形式3

void changeToVTFix()

(3)　引数

linkId（入力）

構成管理型リンクのリンク識別子を指定します。nullを指定すると例外がスローされます。

fixVersionId（入力）

構成管理型リンクによって固定するバージョンのバージョン識別子を指定します。nullを指定するとカレントバージョンになります。

changeMap（入力）

要素のキーには，変更する構成管理型リンクのリンク識別子を指定します。値には，固定するバージョンのバージョン識別子のマップを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていない

NullPointerException

引数linkId，またはchangeMapがnullの場合

4.4.6　changeToVTFloat（構成管理型リンクの構成管理モードをFLOATINGモードに変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトが指定した構成管理型リンクの構成管理モードをFLOATINGモードに変更します。

形式１では，変更する構成管理型リンクのリンク識別子を指定して常に最新のバージョンになるようにします。形式２では，変更する構成管理型リンクのリンク識別子を要素としたリストを指定して常に最新のバージョンになるようにします。形式３では，自オブジェクトのすべての構成管理型リンクが常に最新のバージョンになるようにします。

(2)　形式

(a)　形式1

void changeToVTFloat(
    String     linkId
)

(b)　形式2

void changeToVTFloat(
    List     linkIdList
)

(c)　形式3

void changeToVTFloat()

(3)　引数

linkId（入力）

構成管理型リンクのリンク識別子を指定します。nullを指定すると例外がスローされます。

linkIdList（入力）

要素に構成管理型リンクのリンク識別子のリストを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていない

NullPointerException

引数linkId，またはlinkIdListがnull

4.4.7　checkIn（バージョン付きオブジェクトのチェックイン）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のバージョン付きオブジェクトをチェックインします。チェックインできるターゲットオブジェクトは，バージョン付きオブジェクトだけです。

形式１および形式２では，チェックインと同時にProxyオブジェクトに設定されているプロパティ値集合が，チェックイン後のカレントバージョンを対象としてプロパティに設定されます。形式２では，設定するプロパティを限定できます（指定したプロパティだけが設定の対象になります）。形式３では，Proxyオブジェクトのものに関係なく，指定したプロパティ値集合がカレントバージョンを対象として設定されます。Proxyオブジェクトのターゲットバージョン識別子のプロパティは，新しいカレントバージョン（null）になります。

(2)　形式

(a)　形式1

void checkIn()

(b)　形式2

void checkIn(
    Collection     propDefs
)

(c)　形式3

void checkIn(
    DbjPropSet     propSet
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。チェックイン後のカレントバージョンを対象としたバージョン付きオブジェクトに設定するProxyオブジェクトのプロパティとして，どのプロパティを設定するかを指定します。nullを指定するとプロパティは設定されません。

propSet（入力）

チェックイン後のカレントバージョンを対象とした，バージョン付きオブジェクトに設定するプロパティ値集合を指定します。nullを指定するとプロパティは設定されません。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceCurrentContentNotfoundException

リファレンスファイル管理機能を使用するバージョン付きの文書オブジェクトで，カレントバージョンにコンテンツが存在しなかった場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjNotCheckOutException

チェックアウトしていなかった場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

NullPointerException

引数propSetがnullの場合

4.4.8　checkOut（バージョン付きオブジェクトのチェックアウト）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のバージョン付きオブジェクトをチェックアウトします。チェックアウトによって，チェックアウト中の仮のバージョン識別子を取得します。チェックアウトできるターゲットオブジェクトは，バージョン付きオブジェクトだけです。

形式１および形式２では，チェックアウトと同時にProxyオブジェクトに設定されているプロパティ値集合がチェックアウト中の仮のバージョンを対象としてプロパティに設定されます。形式２では，設定するプロパティを限定できます（指定したプロパティだけが，プロパティ設定の対象になります）。形式３では，Proxyオブジェクトのものに関係なく，指定したプロパティ値集合が仮のバージョンを対象として設定されます。

なお，マルチレンディションの文書をチェックアウトする場合は，チェックアウト時にレンディションがコピーされます。この場合，コンテンツはコピーされません。また，Proxyオブジェクトのターゲットバージョン識別子のプロパティは，チェックアウト中のバージョンを指します。

(2)　形式

(a)　形式1

void checkOut()

(b)　形式2

void checkOut(
    Collection     propDefs
)

(c)　形式3

void checkOut(
    DbjPropSet     propSet
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。チェックアウト後の仮のバージョンオブジェクトを対象としたバージョン付きオブジェクトに設定するProxyオブジェクトのプロパティとして，どのプロパティを設定するかを指定します。nullを指定するとプロパティは設定されません。

propSet（入力）

チェックアウト後の仮のバージョンオブジェクトを対象としたバージョン付きオブジェクトに設定するプロパティ値集合を指定します。nullを指定するとプロパティは設定されません。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjAlreadyCheckOutException

すでにチェックアウトしている場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有エラーの場合

DbjFileReferenceCurrentContentNotfoundException

リファレンスファイル管理機能を使用するバージョン付きの文書オブジェクトで，カレントバージョンにコンテンツが存在しなかった場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

NullPointerException

引数propSetがnullの場合

4.4.9　deleteRendition（レンディションの削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書から指定したレンディションタイプのレンディションを削除します。レンディションの削除によって，存在しなかったレンディションタイプのリストが返却されます。レンディションを削除できるターゲットオブジェクトは，文書だけです。

(2)　形式

List deleteRendition(
    List          renditionTypeList
)

(3)　引数

renditionTypeList（入力）

要素には，削除するレンディションタイプ（String型）のリストを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

すでに削除されていたレンディションタイプ（String型）のリスト

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIsMasterRenditionException

マスタレンディションを削除しようとした場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数renditionTypeListがnullの場合

4.4.10　deleteVersion（バージョンの削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のバージョン付きオブジェクトから指定した複数のバージョンを削除します。バージョンを削除できるターゲットオブジェクトは，文書だけです。ただし，複数のバージョンを削除する場合，１バージョンは残す必要があります。もし，すべてのバージョンを指定した場合は，例外がスローされます。バージョンの削除によって，すでに削除されていたバージョンなど，削除されなかったバージョンのバージョン識別子のリストが返却されます。

(2)　形式

List deleteVersion(
    List     versionIds
)

(3)　引数

versionIds（入力）

要素には，削除するバージョンのバージョン識別子（String型）のリストを指定します。バージョン識別子にnullを指定するとカレントバージョンになります。バージョン識別子が重複していてもエラーにはなりません。nullを指定すると例外がスローされます。

(4)　戻り値

すでに削除されていたオブジェクトのバージョンのバージョン識別子（String型）のリスト

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceCurrentContentNotfoundException

リファレンスファイル管理機能を使用するバージョン付きの文書オブジェクトで，カレントバージョンにコンテンツが存在しなかった場合

DbjFileReferenceMismatchStatusException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作でエラーが発生し，オブジェクトとコンテンツが不整合な状態になった場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjLastVersionException

最後のバージョンを削除しようとした場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

NullPointerException

引数versionIdsがnullの場合

4.4.11　downloadContents（文書のコンテンツのダウンロード）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書のコンテンツをダウンロードします。

形式1では，レンディションタイプを指定した文書のコンテンツを，指定したローカルファイルにダウンロードします。リファレンスファイル文書に対しては実行できません。形式2では，リファレンスファイル文書のコンテンツを，指定したパスにダウンロードします。リファレンスファイル文書に対してだけ実行できます。なお，ダウンロードの対象になるターゲットオブジェクトは，文書だけです。

(2)　形式

(a)　形式1

DbjContentInfo downloadContents(
    String     renditionType,
    String     filePath
)

(b)　形式2

DbjReferenceContentInfo downloadContents(
    String                     renditionType,
    DbjReferencePathInfo       pathInfo
)

(3)　引数

renditionType（入力）

レンディションタイプを指定します。nullを指定するとマスタレンディションが仮定されます。

filePath（入力）

ダウンロード先のパス名（ローカルファイル，およびファイル名を含みます）を指定します。nullを指定すると例外がスローされます。

pathInfo（入力）

ダウンロード先の情報を指定します。nullを指定すると例外がスローされます。

(4)　戻り値

形式1の場合

コンテンツ情報（DbjContentInfoインターフェース）

形式2の場合

リファレンスファイル文書のコンテンツ情報（DbjReferenceContentInfoインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjContentNotRegisteredException

リファレンスファイル管理機能を使用したオブジェクトをローカルファイルにダウンロードする場合に，オブジェクトにコンテンツが登録されていなかったとき

DbjContentTypeMismatchException

リファレンスファイル管理機能で，オブジェクトのコンテンツ種別とメソッドが要求するコンテンツ種別が一致しない場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIOException

Java クラスライブラリ固有のIOエラーの場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjRenditionNotFoundException

指定レンディションが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

NullPointerException

引数filePathまたは引数pathInfoがnullの場合

4.4.12　getBindObjectList（パブリックACLにバインドしている文書空間オブジェクト一覧の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のパブリックACLにバインドされている文書空間オブジェクトの一覧情報を取得します。一覧情報を取得できるターゲットオブジェクトは，パブリックACLだけです。取得対象とするオブジェクトのオブジェクト種別を指定できます。

バージョン付きオブジェクトが取得対象のオブジェクトに含まれる場合は，バージョニングオブジェクトのプロパティだけ取得でき，バージョンオブジェクトのプロパティは取得できません。

(2)　形式

DbjObjList getBindObjectList(
    Collection         propDefs,
    int                objType,
    DbjFetchInfo       fetchInfo
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するオブジェクトのプロパティ名のコレクションを指定します。取得するプロパティがない場合はnullを指定します。

objType（入力）

一覧で取得するオブジェクトのオブジェクト種別を指定します。次に示す定数のどれかを指定できます。なお，論理和を使用した指定もできます。

DbjDef.OBJTYPE_FOLDER
バージョンなしフォルダ

DbjDef.OBJTYPE_DOC
バージョンなし文書

DbjDef.OBJTYPE_VRDOC
バージョン付き文書

DbjDef.OBJTYPE_IP
独立データ

DbjDef.OBJTYPE_VRFOLDER
バージョン付きフォルダ

DbjDef.OBJTYPE_ANY
任意のオブジェクト種別

fetchInfo（入出力）

一覧で取得する場合の検索結果取得情報を指定します。全件を取得する場合，またはキャッシュ検索しない場合はnullを指定します。全件を取得しない場合，maxFetchCountプロパティに指定されている件数を取得した後に，comparatorプロパティに指定したコンパレータによりソートされます。そのため，全件を取得する場合と，maxFetchCountプロパティを指定して検索した場合を比較すると，comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

(4)　戻り値

バインドしているオブジェクト一覧情報（DbjObjListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjAccessControlNotSupportedException

アクセス制御機能に対応していない文書だった場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalCacheStartIndexException

検索結果数より大きい値を引数fetchInfo（DbjFetchInfoインターフェース）のstartIndexプロパティに指定した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalArgumentException

引数fetchInfoの指定が不正の場合

4.4.13　getCheckOutStatus（バージョン付きオブジェクトのチェックアウト状態の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のバージョン付きオブジェクトのチェックアウト状態を取得します。DbjCheckOutInfoインターフェースを使用して，チェックアウト状態，チェックアウトしているユーザ識別子，チェックアウトしている仮のバージョンのバージョン識別子などを取得できます。チェックアウト状態を取得できるターゲットオブジェクトは，バージョン付きオブジェクトだけです。

(2)　形式

DbjCheckOutInfo getCheckOutStatus()

(3)　引数

なし

(4)　戻り値

チェックアウト情報（DbjCheckOutInfoインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.14　getChildList（フォルダのリンク先オブジェクト（下位オブジェクト）の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のフォルダにリンクが設定されているリンク先オブジェクト（下位オブジェクト）の一覧情報を取得します。取得対象とするリンク種別とリンク先オブジェクトのオブジェクト種別を指定できます。

ユーザアプリケーションプログラムの取得対象のオブジェクトに，リンク種別として直接型リンクまたは参照型リンクを指定し，バージョン付きオブジェクトが含まれる場合について説明します。この場合，取得対象のオブジェクトがバージョニングオブジェクトのときは，バージョニングオブジェクトのプロパティだけ取得でき，バージョンオブジェクトのプロパティは取得できません。また，取得対象のオブジェクトがバージョニングオブジェクトを構成するバージョンオブジェクトのときは，バージョンオブジェクトのプロパティだけ取得できます。ただし，プロパティの指定には＠プレフィックスを付けないで指定します。

ユーザアプリケーションプログラムの取得対象のオブジェクトに，リンク種別として構成管理型リンクを指定し，バージョン付きオブジェクトが含まれる場合について説明します。この場合，バージョンオブジェクトのプロパティを取得できます。プロパティの指定には，＠プレフィックスを付けないで指定します。バージョニングオブジェクトのプロパティは取得できません。戻り値のリンクオブジェクト一覧情報から取得できるリンク先オブジェクトは，構成管理の対象となるバージョン付きオブジェクトです。このバージョンオブジェクトに対するバージョニングオブジェクトを取得する場合は，getVersioningInfoメソッドを使用します。

(2)　形式

DbjLinkObjList getChildList(
    Collection          propDefs,
    Collection          linkPropDefs,
    int                 linkType,
    int                 objType,
    DbjFetchInfo        fetchInfo
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するリンク先オブジェクトのプロパティ名のコレクションを指定します。取得するプロパティがない場合はnullを指定します。

linkPropDefs（入力）

要素はプロパティ名(String型)です。一覧で取得するリンクプロパティ名のコレクションを指定します。取得するリンクプロパティがない場合はnullを指定します。

linkType（入力）

リンク種別を指定します。次に示す定数のどれかを指定できます。なお，論理和を使用した指定もできます。

DbjDef.LINK_DCR
直接型リンク

DbjDef.LINK_RCR
参照型リンク

DbjDef.LINK_DCR | DbjDef.LINK_RCR
直接型リンクまたは参照型リンク

DbjDef.LINK_VTFIX
構成管理型リンク（構成管理モードはFIXモード）

DbjDef.LINK_VTFLOAT
構成管理型リンク（構成管理モードはFLOATINGモード）

DbjDef.LINK_VTFIX | DbjDef.LINK_VTFLOAT
構成管理モードがFIXモードの構成管理型リンク，または構成管理モードがFLOATINGモードの構成管理型リンク

objType（入力）

一覧で取得するリンク先オブジェクトのオブジェクト種別を指定します。次に示す定数のどれかを指定できます。なお，論理和を使用した指定もできます。

リンク種別に構成管理型リンク（DbjDef.LINK_VTFIXまたはDbjDef.LINK_VTFLOAT）を指定した場合は，バージョン付き文書（DbjDef.OBJTYPE_VRDOC），バージョン付きフォルダ（DbjDef.OBJTYPE_VRFOLDER）または任意のオブジェクト種別（DbjDef.OBJTYPE_ANY）だけが有効になります。

DbjDef.OBJTYPE_FOLDER
バージョンなしフォルダ

DbjDef.OBJTYPE_DOC
バージョンなし文書

DbjDef.OBJTYPE_VRDOC
バージョン付き文書

DbjDef.OBJTYPE_VRFOLDER
バージョン付きフォルダ

DbjDef.OBJTYPE_ANY
任意のオブジェクト種別

fetchInfo（入出力）

一覧で取得する場合の検索結果取得情報を指定します。全件を取得する場合，またはキャッシュ検索をしない場合はnullを指定します。

全件を取得しない場合，maxFetchCountプロパティに指定されている件数を取得した後に，comparatorプロパティに指定したコンパレータによりソートされます。そのため，全件を取得する場合と，maxFetchCountプロパティを指定して検索した場合を比較すると，comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

(4)　戻り値

リンクオブジェクト一覧情報（DbjLinkObjListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalCacheStartIndexException

検索結果数より大きい値を引数fetchInfo（DbjFetchInfoインターフェース）のstartIndexプロパティに指定した場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalArgumentException

引数linkType，fetchInfoの指定が不正の場合

4.4.15　getClassName（アクセス対象文書空間オブジェクトを構成するDMAクラス名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトのDMAクラス名を取得します。

バージョンオブジェクトについては，バージョニングオブジェクトおよびバージョンオブジェクトを構成する二つのDMAクラスのクラス名をこの順に返し，このほかのオブジェクトについては一つのDMAクラスのクラス名を返します。ただし，バージョン付きオブジェクトに対しては，アクセス権エラーが発生するおそれがあります。

(2)　形式

List getClassName()

(3)　引数

なし

(4)　戻り値

要素をDMAクラスのクラス名（String型）とするリストインターフェース

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.16　getDCRParent（直接型リンクによるリンク元オブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のフォルダに直接型リンクが設定されているリンク元（上位）オブジェクトの情報を取得します。リンク元オブジェクトがない場合は，nullが返却されます。リンクオブジェクトについての情報（リンク識別子）は取得できません。

(2)　形式

DbjObj getDCRParent(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。取得するリンク元オブジェクトのプロパティ名のコレクションを指定します。取得するプロパティがない場合はnullを指定します。

(4)　戻り値

リンク元のリンクオブジェクト（DbjObjインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.17　getLockType（Proxyオブジェクトのアクセスロック種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトにアクセスする場合のロック種別（Proxyオブジェクトのアクセスロック種別のプロパティ）を取得します。取得するロック種別は，参照系メソッドによって取得するロック種別です。

(2)　形式

int getLockType()

(3)　引数

なし

(4)　戻り値

次のどちらかのロック種別を取得します。

DbjDef.LOCK_READ

readロックを取得します。

DbjDef.LOCK_WRITE

writeロックを取得します。

(5)　例外

なし

4.4.18　getObjType（アクセス対象文書空間オブジェクトのオブジェクト種別の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのオブジェクト種別を取得します。

(2)　形式

int getObjType()

(3)　引数

なし

(4)　戻り値

次のどれかのオブジェクト種別が返却されます。

DbjDef.OBJTYPE_DOC

バージョンなし文書です。

DbjDef.OBJTYPE_FOLDER

バージョンなしフォルダです。

DbjDef.OBJTYPE_VRDOC

バージョン付き文書です。

DbjDef.OBJTYPE_VRFOLDER

バージョン付きフォルダです。

DbjDef.OBJTYPE_IP

独立データです。

DbjDef.OBJTYPE_PUBLICACL

パブリックACLです。

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.19　getOiid（アクセス対象文書空間オブジェクトのOIIDの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのOIIDを取得します。

(2)　形式

String getOiid()

(3)　引数

なし

(4)　戻り値

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのOIID文字列（String型）

(5)　例外

なし

4.4.20　getParentList（フォルダのリンク元オブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象のフォルダにリンクが設定されているリンク元オブジェクトの一覧情報を取得します。取得対象のリンク種別およびリンク元オブジェクトのオブジェクト種別を指定できます。

このメソッドのリンク種別にDbjDef.LINK_VTを指定した場合，取得したリンクオブジェクトには構成管理モード（FIXモードまたはFLOATINGモード）の区別がありません。したがって，このメソッドで取得したリンクオブジェクトの構成管理モードがFIXモードまたはFLOATINGモードのどちらの場合であっても，リンク種別にはDbjDef.LINK_VTが設定されます。

(2)　形式

DbjLinkObjList getParentList(
    Collection          propDefs,
    Collection          linkPropDefs,
    int                 linkType,
    int                 objType,
    DbjFetchInfo        fetchInfo
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するリンク元オブジェクトのプロパティ名のコレクションを指定します。取得するプロパティがない場合はnullを指定します。

linkPropDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するリンクプロパティ名のコレクションを指定します。取得するリンクプロパティがない場合はnullを指定します。

linkType（入力）

リンク種別を指定します。次に示す定数のどれかを指定できます。

DbjDef.LINK_DCR
直接型リンク

DbjDef.LINK_RCR
参照型リンク

DbjDef.LINK_DCR | DbjDef.LINK_RCR
直接型リンクまたは参照型リンク

DbjDef.LINK_VT（=DbjDef.LINK_VTFIX | DbjDef.LINK_VTFLOAT）
構成管理モードがFIXモードの構成管理型リンク，または構成管理モードがFLOATINGモードの構成管理型リンク

objType（入力）

一覧で取得するリンク先オブジェクトのオブジェクト種別を指定します。次に示す定数のどれかを指定できます。なお，論理和を使用した指定もできます。

DbjDef.OBJTYPE_FOLDER
バージョンなしフォルダ

DbjDef.OBJTYPE_VRFOLDER
バージョン付きフォルダ

DbjDef.OBJTYPE_ANY
任意のオブジェクト種別

fetchInfo（入出力）

一覧で取得する場合の検索結果取得情報を指定します。全件を取得する場合，またはキャッシュ検索をしない場合はnullを指定します。全件を取得しない場合，maxFetchCountプロパティに指定されている件数を取得した後に，comparatorプロパティに指定したコンパレータによりソートされます。そのため，全件を取得する場合と，maxFetchCountプロパティを指定して検索した場合を比較すると，comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

(4)　戻り値

リンクオブジェクト一覧情報（DbjLinkObjListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalCacheStartIndexException

検索結果数より大きい値を引数fetchInfo（DbjFetchInfoインターフェース）のstartIndexプロパティに指定した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalArgumentException

引数linkType，fetchInfoの指定が不正の場合

4.4.21　getPublicACLList（バインドしているパブリックACL一覧の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトがバインドしているパブリックACLの一覧情報を取得します。ただし，Proxyオブジェクトのアクセス対象の文書空間オブジェクトには，パブリックACLを指定しないでください。

(2)　形式

DbjObjList getPublicACLList(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するパブリックACLのプロパティ名のコレクションを指定します。取得するプロパティがない場合はnullを指定します。

(4)　戻り値

バインドしているパブリックACL一覧情報（DbjObjListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjAccessControlNotSupportedException

アクセス制御機能に対応していない文書空間だった場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.22　getRelList（文書間リンク一覧の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書に文書間リンクが設定されている文書の一覧情報を取得します。一覧情報を取得できるターゲットオブジェクトは，文書だけです。この場合，取得対象とするオブジェクトのオブジェクト種別を指定できます。また，引数（relationendType）の指定によって，取得するオブジェクトの情報をフィルタリングできます。

(2)　形式

DbjLinkObjList getRelList(
    Collection          propDefs,
    Collection          linkPropDefs,
    int                 relationendType,
    int                 objType,
    DbjFetchInfo        fetchInfo
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するリンク先オブジェクトのプロパティ名集合を指定します。取得するプロパティがない場合はnullを指定します。

linkPropDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するリンクプロパティ名集合を指定します。取得するリンクプロパティがない場合はnullを指定します。

relationendType（入力）

取得するオブジェクトの条件を指定します。次に示す定数のどれかを指定できます。RELATIONEND_STATUS定数を指定しない場合は，リンク先のオブジェクトはすべて取得します。なお，DbjDef.RELATIONEND_HEADまたはDbjDef.RELATIONEND_TAILのどちらか一つは，必ず指定してください。

DbjDef.RELATIONEND_HEAD
リンク先オブジェクトを取得します。RELATIONEND_TAILと同時に指定できません。

DbjDef.RELATIONEND_TAIL
リンク元オブジェクトを取得します。RELATIONEND_HEADと同時に指定できません。

DbjDef.RELATIONEND_STATUS_EXIST
リンク先オブジェクトがあるオブジェクトを取得します。

DbjDef.RELATIONEND_STATUS_NOT_EXIST
リンク先オブジェクトが削除されて存在しないオブジェクトを取得します。

objType（入力）

一覧で取得するリンク元またはリンク先オブジェクトのオブジェクト種別を指定します。次に示す定数のどれかを指定できます。なお，論理和を使用した指定もできます。

DbjDef.OBJTYPE_DOC
バージョンなし文書

DbjDef.OBJTYPE_VRDOC
バージョン付き文書

DbjDef.OBJTYPE_ANY
任意のオブジェクト種別

fetchInfo（入出力）

一覧で取得する場合の検索結果取得情報を指定します。全件を取得する場合，またはキャッシュ検索をしない場合はnullを指定します。全件を取得しない場合，maxFetchCountプロパティに指定されている件数を取得した後に，comparatorプロパティに指定したコンパレータによりソートされます。そのため，全件を取得する場合と，maxFetchCountプロパティを指定して検索した場合を比較すると，comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

(4)　戻り値

リンクオブジェクト一覧情報（DbjLinkObjListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalCacheStartIndexException

検索結果数より大きい値を引数fetchInfo（DbjFetchInfoインターフェース）のstartIndexプロパティに指定した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalArgumentException

引数fetchInfoの指定が不正の場合

4.4.23　getRenditionList（レンディション情報一覧の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書が保持するレンディション情報の一覧をすべて取得します。レンディション情報を取得できるアクセス対象の文書空間オブジェクトは，文書だけです。

(2)　形式

DbjRenditionList getRenditionList(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はレンディションプロパティ名（String型）です。一覧で取得するレンディションのプロパティ名のコレクションを指定します。取得するレンディションプロパティがない場合はnullを指定します。次に示すプロパティを指定できます。

dbrProp_RetrievalNameプロパティ

dbrProp_RenditionStatusプロパティ

dbrProp_ContentTypeプロパティ

(4)　戻り値

レンディション一覧情報（DbjRenditionListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.24　getTargetVersion（アクセス対象ターゲットバージョンのバージョン識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのバージョンのバージョン識別子を取得します。

(2)　形式

String getTargetVersion()

(3)　引数

なし

(4)　戻り値

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのバージョンのバージョン識別子（String型）が返却されます。なお，カレントバージョンの場合は，nullが返却されることがあります。

(5)　例外

なし

4.4.25　getVersionId（バージョンオブジェクトのバージョン識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象オブジェクトがバージョン付きオブジェクトのバージョンオブジェクトの場合，そのバージョン識別子を取得します。アクセス対象の文書空間オブジェクトがバージョンオブジェクトでない場合は，nullが返却されます。

(2)　形式

String getVersionId()

(3)　引数

なし

(4)　戻り値

バージョンオブジェクトのバージョン識別子（String型）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.26　getVersioningInfo（バージョン付きオブジェクトのバージョニングオブジェクトの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトがバージョン付きオブジェクトの場合，このバージョンオブジェクトに対応するバージョニングオブジェクトのProxyオブジェクトインターフェース（DbjObjインターフェース）を取得します。該当するバージョンのバージョン識別子は，そのProxyオブジェクトインターフェースのDbjObj#getTargetVersionメソッドで取得できます。したがって，取得したDbjObjインターフェースが指すProxyオブジェクトの対象バージョンは，Proxyオブジェクトのバージョン識別子を示します。

アクセス対象の文書空間オブジェクトがバージョンオブジェクトでない場合，nullが返却されます。

(2)　形式

DbjObj getVersioningInfo()

(3)　引数

なし

(4)　戻り値

バージョン付きオブジェクトのProxyオブジェクトインターフェース（DbjObjインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.4.27　getVersionObjList（バージョン付きオブジェクトのバージョン一覧の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象であるバージョン付きオブジェクトのバージョンオブジェクトの一覧情報を取得します。一覧情報を取得するアクセス対象の文書空間オブジェクトは，バージョン付きオブジェクトだけです。取得対象のバージョンオブジェクトから取得するプロパティを指定できます。また，一覧で取得するバージョンオブジェクトの並べ方を指定できます。

(2)　形式

DbjVerObjList getVersionObjList(
    Collection             propDefs,
    int                    order,
    DbjFetchInfo           fetchInfo
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。一覧で取得するバージョンオブジェクトのプロパティ名のコレクションを指定します。取得するプロパティがない場合はnullを指定します。

dmaProp_OIIDプロパティを指定しない場合，dmaProp_OIIDプロパティが自動的に追加されるものとみなします。

order（入力）

一覧で取得する場合の並べ方を指定します。次の定数のどれかを指定できます。

DbjDef.ORDER_ASC
古い順でソートする

DbjDef.ORDER_DESC
新しい順でソートする

DbjDef.ORDER_NONE
ソート方法を指定しない

fetchInfo（入出力）

一覧で取得する場合の検索結果取得情報を指定します。全件を取得する場合，またはキャッシュ検索をしない場合はnullを指定します。

キャッシュ検索するとcacheKeyプロパティとcacheTotalプロパティがAPIによって設定されます。全件を取得しない場合，maxFetchCountプロパティに指定されている件数を取得した後に，comparatorプロパティに指定したコンパレータによりソートされます。そのため，全件を取得する場合と，maxFetchCountプロパティを指定して検索した場合を比較すると，comparatorプロパティに同じオブジェクトを指定しても結果が異なる場合があります。

(4)　戻り値

バージョンオブジェクトの一覧情報（DbjVerObjListインターフェース）

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalCacheStartIndexException

検索結果数より大きい値を引数fetchInfo（DbjFetchInfoインターフェース）のstartIndexプロパティに指定した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalArgumentException

引数fetchInfoの指定が不正の場合

4.4.28　link（リンク先オブジェクトとのリンク）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象オブジェクトのリンク元オブジェクトに，指定した複数のリンク先オブジェクトとのリンクを設定します。

形式１では，DbjSetLinkInfoインターフェースを要素とするリストオブジェクトで，リンク先オブジェクトとリンク種別を指定します。この場合，リンク先オブジェクトごとにリンク種別を選択できます。形式２では，リンク種別は一つだけ選択でき，DbjObjインターフェースのリストにリンク先オブジェクトを指定できます。

(2)　形式

(a)　形式1

void link(
    List     childLinkList
)

(b)　形式2

void link(
    int      linkType,
    List     childObjs
)

(3)　引数

childLinkList（入力）

要素はDbjSetLinkInfoインターフェースのサブインターフェースです。リンクを設定するリンク先オブジェクトとそのリンクの種類のリストを指定します。nullを指定すると例外がスローされます。

linkType（入力）

リンク種別を指定します。次のどれかを指定できます。

DbjDef.LINK_DCR
直接型リンク

DbjDef.LINK_RCR
参照型リンク

DbjDef.LINK_VTFIX
構成管理型リンク（構成管理モードはFIXモード）

DbjDef.LINK_VTFLOAT
構成管理型リンク（構成管理モードはFLOATINGモード）

DbjDef.LINK_REL
文書間リンク

childObjs（入力）

要素はDbjObjインターフェースです。リンク対象のリンク先オブジェクトのリストを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

ClassCastException

リスト引数の要素が不適切の場合

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalArgumentException

引数linkTypeが不正の場合

NullPointerException

引数childLinkList，またはchildObjsがnullの場合

4.4.29　lock（アクセスロック種別の異なる文書空間オブジェクトインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトに，指定したロック種別でロックを取得するProxyオブジェクトのインターフェース（DbjObjインターフェース）を取得します。

元のDbjObjインターフェース（this）でアクセスする際のロック種別は，変更されません。なお，引数に指定する値の妥当性は検証されません。

(2)　形式

DbjObj lock(
    int     lockType
)

(3)　引数

lockType（入力）

ロック種別を指定します。次に示す定数のどちらかを指定します。

DbjDef.LOCK_READ
readロック

DbjDef.LOCK_WRITE
writeロック

(4)　戻り値

DbjObjインターフェース（DbjObjインターフェース）

(5)　例外

なし

4.4.30　move（直接型リンクが設定されている文書空間オブジェクトの移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトに対してリンク元オブジェクトから直接型リンクが設定されている場合，そのリンクを解除して代わりに指定したリンク元フォルダオブジェクトに直接型リンクを設定します。文書空間オブジェクトに直接型リンクが設定されていない場合は，指定したリンク元フォルダに直接型リンクを設定します。

(2)　形式

void move(
    DbjObj     parentFolder
)

(3)　引数

parentFolder（入力）

自オブジェクトが移動するリンク元フォルダを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数parentFolderがnullの場合

4.4.31　propSet（Proxyオブジェクトのプロパティ値集合インターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのプロパティ値集合インターフェースを取得します。プロパティ値集合インターフェースは，参照権限で取得します。取得したプロパティ値集合インターフェースを使用して値を設定するとProxyオブジェクトのプロパティ値も更新されます。ただし，メソッド実行時に，プロパティ値集合インターフェースが設定されていなくてもnullは返却されません。

(2)　形式

DbjPropSet propSet()

(3)　引数

なし

(4)　戻り値

Proxyオブジェクトのプロパティ値集合インターフェース（DbjPropSetインターフェース）

(5)　例外

なし

4.4.32　readProperties（文書空間オブジェクトのプロパティ値の読み込み）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトの指定プロパティを，Proxyオブジェクトのプロパティに読み込みます。Proxyオブジェクトに読み込まれたプロパティ値集合は，DbjObj#propSetメソッドでDbjPropSetインターフェースを取得して参照できます。読み込まれたプロパティ値集合は，Proxyオブジェクトで保持しているプロパティ値集合に上書きして追加されます。

形式１では，Proxyオブジェクトの保持しているプロパティ値集合でのすべてのプロパティを文書空間オブジェクトから読み込みます。形式２では，読み込み対象のプロパティのコレクションを指定します。

(2)　形式

(a)　形式1

void readProperties()

(b)　形式2

void readProperties(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。取得するプロパティのプロパティ名のコレクションを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propDefsがnullの場合

4.4.33　removeObject（文書空間オブジェクトの削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトを削除します。

形式２では，フォルダの削除の場合は直接型リンクが設定されているすべてのリンク先オブジェクトを削除します。

形式３では，リファレンスファイル管理機能を使用したオブジェクトを削除すると同時に，コンテンツを格納していたフォルダを削除できます。

なお，デッドロックを防止するため，リンク先オブジェクトを削除する場合は，リンク元オブジェクトを削除するまたはリンク元オブジェクトにwriteロックします。このメソッドの実行時に，文書空間オブジェクトが存在しない場合，例外はスローされません。

(2)　形式

(a)　形式1

boolean removeObject()

(b)　形式2

boolean removeObject(
    boolean     isAlsoChildren
)

(c)　形式3

boolean removeObject(
    DbjReferencePathInfo      pathInfo
)

(3)　引数

isAlsoChildren（入力）

リンク先オブジェクトの削除を指定します。trueの場合，リンク先オブジェクトを削除します。falseの場合，リンク先オブジェクトを削除しません。

pathInfo（入力）

リファレンスファイル管理機能を使用したオブジェクトの削除時に使用する，パス情報を設定します。nullを指定すると例外がスローされます。

(4)　戻り値

次に示す値が返却されます。

true

リンク先オブジェクトが削除されました。

false

該当する文書空間オブジェクトが存在しませんでした。

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceCurrentContentNotfoundException

リファレンスファイル管理機能を使用するバージョン付きの文書オブジェクトで，カレントバージョンにコンテンツが存在しなかった場合

DbjFileReferenceMismatchStatusException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作でエラーが発生し，オブジェクトとコンテンツが不整合な状態になった場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjLastVersionException

最後のバージョンを削除しようとした場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjReferenceTypeMismatchException

リファレンスファイル管理機能で，オブジェクトのリファレンス種別とメソッドが要求するリファレンス種別が一致しない場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

NullPointerException

引数pathInfoがnullの場合

4.4.34　setPropSet（Proxyオブジェクトのプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのプロパティ値集合に，指定したプロパティ値集合の内容をコピーして設定します。

(2)　形式

void setPropSet(
    DbjPropSet     propSet
)

(3)　引数

propSet（入力）

プロパティ値集合インターフェースを指定します。nullを指定するとオブジェクトのプロパティ値集合には空値が仮定されます。

(4)　戻り値

なし

(5)　例外

なし

4.4.35　setTargetVersion（アクセス対象ターゲットバージョンのバージョン識別子の変更）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのバージョンのバージョン識別子を変更します。バージョン識別子の変更によって，元のDbjObjインターフェースを取得します。デフォルトでは，Proxyオブジェクトのアクセス対象のバージョンは，カレントバージョンになります。なお，バージョン識別子の妥当性は検証されません。

(2)　形式

DbjObj setTargetVersion(
    String     versionId
)

(3)　引数

versionId（入力）

変更する対象バージョンのバージョン識別子を指定します。nullを指定するとカレントバージョンに変更されます。

(4)　戻り値

元のオブジェクトインターフェース（this）

(5)　例外

なし

4.4.36　unbindPublicACL（パブリックACLのアンバインド）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象の文書空間オブジェクトから指定したパブリックACLをアンバインドします。ただし，Proxyオブジェクトがアクセスする文書空間オブジェクトには，パブリックACLを指定しないでください。

(2)　形式

void unbindPublicACL(
    List     publicACLList
)

(3)　引数

publicACLIdList（入力）

要素はDbjObjインターフェースです。各要素に，アンバインドするパブリックACLを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

ClassCastException

引数publicACLListの要素がDbjObjインターフェースでなかった場合

DbjAccessControlException

アクセス権エラーの場合

DbjAccessControlNotSupportedException

接続先の文書空間がアクセス制御動作モードに対応していなかった場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotBoundException

指定パブリックACLがバインドされていない場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数publicACLIdListがnullの場合

4.4.37　unlink（リンク先オブジェクトとのリンクの解除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのリンク元オブジェクトから，指定した複数のリンク先オブジェクトとのリンクを解除します。

リンクを解除するリンク先オブジェクトは，DbjLinkObjインターフェースまたはDbjObjインターフェースを要素とするリストで指定します。DbjLinkObjインターフェースとDbjObjインターフェースを同時に指定することもできます。DbjObjインターフェースを指定した場合，そのDbjObjインターフェースが指す文書空間オブジェクトとの直接型リンクおよび参照型リンクがすべて解除されます。

なお，指定したリンクがすでに解除されていた場合は，そのリンクまたはリンク先オブジェクトのインターフェースを要素とするリストが戻り値として返却されます。

(2)　形式

List unlink(
    List     childList
)

(3)　引数

childList（入力）

要素はDbjLinkObjインターフェースまたはDbjObjインターフェースです。

リストの要素として，リンクを解除するリンクオブジェクトのインターフェースまたはリンク先オブジェクトのインターフェースを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

すでにリンクが解除されていたインターフェースのリスト

(5)　例外

ClassCastException

リスト引数の要素が不適切の場合

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数childLinkList，またはchildObjsがnullの場合

4.4.38　unlinkByLinkId（リンク識別子の指定によるリンク先オブジェクトとのリンクの解除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのリンク元オブジェクトから複数のリンク先オブジェクトのリンク識別子を指定してリンクを解除します。なお，すでにリンクが解除されていたため，メソッドの実行によってリンクが解除されなかったリンクのリンク識別子の要素が返却されます。

(2)　形式

List unlinkByLinkId(
    List     linkIds
)

(3)　引数

linkIds（入力）

要素には，解除するリンク識別子（String型）のリストを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

すでにリンクが解除されていたため，メソッドの実行によって，リンクが解除されなかったリンクのリンク識別子（String型）のリスト

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数linkIdsがnullの場合

4.4.39　uploadContents（文書のコンテンツのアップロード）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したレンディションタイプのコンテンツをアップロードして更新します。アップロードの対象になるターゲットオブジェクトは，文書だけです。また，マルチレンディション文書の場合，更新の対象になるレンディションは，指定したレンディションタイプのレンディションだけです。

アップロード情報に指定するレンディションタイプとアップロード対象に指定するレンディションタイプに異なるレンディションを指定した場合，アップロードするコンテンツのレンディションタイプを変更できます。この場合，アップロード情報に指定したレンディションタイプがすでに文書に存在していると，例外がスローされます。アップロード情報の指定でレンディションタイプにnullを設定した場合は，レンディションタイプは変更されません。

リファレンスファイル文書を更新する場合は，引数upLoadInfoにDbjReferenceUploadInfoインターフェースを指定します。

(2)　形式

void uploadContents(
    String               renditionType,
    DbjUploadInfo        uploadInfo
)

(3)　引数

renditionType（入力）

更新対象のレンディションタイプを指定します。nullを指定するとマスタレンディションが仮定されます。

なお，全文検索インデクスを作成できるのは，nullを指定した場合だけです。null以外を指定した場合，全文検索インデクスは作成されません。

uploadInfo（入力）

文書に登録するファイルのアップロード情報を指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjContentTypeMismatchException

リファレンスファイル管理機能で，オブジェクトのコンテンツ種別とメソッドが要求するコンテンツ種別が一致しない場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjFileReferenceMismatchStatusException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作でエラーが発生し，オブジェクトとコンテンツが不整合な状態になった場合

DbjFileReferenceOperationFailedException

リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定レンディションプロパティ値が不正の場合

DbjIOException

Java クラスライブラリ固有のIOエラーの場合

DbjMasterRenditionNotSetException

マスタレンディションのレンディションタイプが設定されていなかった場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjReferenceTypeMismatchException

リファレンスファイル管理機能で，オブジェクトのリファレンス種別とメソッドが要求するリファレンス種別が一致しない場合

DbjRenditionCountOutOfRangeException

指定レンディション数が範囲を超えた場合

DbjRenditionNotFoundException

指定レンディションが存在しなかった場合

DbjRenditionTypeDuplicatedException

指定レンディションタイプが重複していた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

DbjTargetContentPathNotSetException

リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていなかった場合

DbjXmlParseException

XML文書解析エラーの場合

IllegalArgumentException

引数に不正な値が指定されていた場合

NullPointerException

引数uploadInfoがnullの場合

4.4.40　writeProperties（文書空間オブジェクトのプロパティ値の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトのプロパティ値を設定します。

形式１では，Proxyオブジェクトがアクセス対象とする文書空間オブジェクトのプロパティを，指定したプロパティ値集合で設定します。この場合，Proxyオブジェクトのプロパティ値集合は無視されます。形式２および形式３では，Proxyオブジェクトに設定されているプロパティ値集合で文書空間オブジェクトのプロパティを設定します。形式2では，DbjObj#readPropertiesメソッドで読み込んだプロパティ値集合のプロパティ値を書き換えて文書空間オブジェクトのプロパティ値を更新します。形式３では，Proxyオブジェクトに設定されているプロパティのうち，文書空間オブジェクトに反映するプロパティを限定して指定できます。なお，形式３の場合，指定した引数の値によってProxyオブジェクトの保持するプロパティ値集合は変更されません。

(2)　形式

(a)　形式1

void writeProperties(
    DbjPropSet     propSet
)

(b)　形式2

void writeProperties()

(c)　形式3

void writeProperties(
    Collection     propDefs
)

(3)　引数

propSet（入力）

文書空間オブジェクトに設定するプロパティ値集合を指定します。nullを指定すると例外がスローされます。

propDefs（入力）

要素はプロパティ名（String型）です。文書空間オブジェクトに設定する対象になるプロパティ値のコレクションを指定します。Proxyオブジェクトのプロパティ値のコレクションに存在しないプロパティを指定した場合は無視されます。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLが存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propSet，またはpropDefsがnullの場合

4.4.41　writeRenditionProperties（レンディションプロパティの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書の指定レンディションについて，レンディションプロパティを設定します。レンディションプロパティを設定できるターゲットオブジェクトは，文書だけです。

(2)　形式

void writeRenditionProperties(
    String              renditionType,
    DbjPropSet          propSet
)

(3)　引数

renditionType（入力）

設定対象のレンディションタイプを指定します。nullを指定するとマスタレンディションが仮定されます。

propSet（入力）

設定するレンディションのプロパティ値集合を指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjRenditionNotFoundException

指定レンディションが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propSetがnullの場合

4.5　DbjObjListインターフェース

DbjObjListインターフェースは，複数の文書空間オブジェクトに一括してアクセスするインターフェースです。要素は，DbjObjインターフェースです。

スーパーインターフェース

java.util.List

以降，DbjObjListインターフェースのメソッドについて説明します。

＜この節の構成＞

4.5.1　getObj（リスト要素の取得）

4.5.2　lock（アクセスロック種別の異なる複数文書空間オブジェクトインターフェースの取得）

4.5.3　move（直接型リンクが設定されている文書空間オブジェクトの一括移動）

4.5.4　readProperties（複数の文書空間オブジェクトプロパティ値の一括取得）

4.5.5　removeObjects（文書空間オブジェクトの一括削除）

4.5.6　setPropSet（要素のプロパティ値集合の設定）

4.5.7　writeProperties（複数の文書空間オブジェクトプロパティ値の一括設定）

4.5.1　getObj（リスト要素の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

インデクスで指定したリスト要素（DbjObjインターフェース）を取得します。

(2)　形式

DbjObj getObj(
    int     index
)

(3)　引数

index（入力）

要素のインデクスを指定します。

(4)　戻り値

DbjObjインターフェース

(5)　例外

ClassCastException

リスト要素がDbjObjインターフェースでなかった場合

IndexOutOfBoundException

指定したインデクスが不正の場合

4.5.2　lock（アクセスロック種別の異なる複数文書空間オブジェクトインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

アクセス対象の文書空間に対して，指定したアクセスロック種別のロックを保持するDbjObjListインターフェースを取得します。取得されたインターフェースには，要素の文書空間オブジェクトインターフェースのロックの指定よりも優先してロックが指定されます。なお，デフォルトでは，各要素の文書空間オブジェクトインターフェースのロック種別が有効になります。

(2)　形式

DbjObjList lock(
    int     lockType
)

(3)　引数

lockType（入力）

ロック種別として，次に示す定数のどちらかを指定します。

DbjDef.LOCK_READ
readロック

DbjDef.LOCK_WRITE
writeロック

(4)　戻り値

複数文書空間オブジェクトインターフェース（DbjObjListインターフェース）

(5)　例外

なし

4.5.3　move（直接型リンクが設定されている文書空間オブジェクトの一括移動）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リスト要素の文書空間オブジェクトに対してリンク元フォルダから直接型リンクが設定されている場合，そのリンクを解除して引数で指定したリンク元フォルダに直接型リンクを設定します。リスト要素の文書空間オブジェクトに直接型リンクが設定されていない場合は，指定したリンク元フォルダに直接型リンクを設定します。

(2)　形式

void move(
    DbjObj     parentFolder
)

(3)　引数

parentFolder（入力）

要素オブジェクトが移動するリンク元フォルダを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalObjectTypeException

指定オブジェクト種別が不適切の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数parentFolderがnullの場合

4.5.4　readProperties（複数の文書空間オブジェクトプロパティ値の一括取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのアクセス対象である文書空間オブジェクトの指定プロパティを，リストの各要素のProxyオブジェクトに読み込みます。リストの要素の各DbjObjインターフェースに対して，同じ形式のDbjObj#readPropertiesメソッドを実行します。

形式１では，Proxyオブジェクトの保持しているプロパティ値集合でのすべてのプロパティを文書空間オブジェクトから読み込みます。形式２では，読み込み対象のプロパティのコレクションを指定します。

(2)　形式

(a)　形式1

void readProperties()

(b)　形式2

void readProperties(
   Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。取得するプロパティのプロパティ名のコレクションを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propDefsがnullの場合

4.5.5　removeObjects（文書空間オブジェクトの一括削除）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リストオブジェクトの各要素のProxyオブジェクトのアクセス対象の文書空間オブジェクトを一括して削除します。リストの要素の各DbjObjインターフェースに対して，DbjObj#removeObjectメソッドを実行します。

(2)　形式

(a)　形式1

List removeObjects()

(b)　形式2

List removeObjects(
    boolean       isAlsoChildren
)

(3)　引数

isAlsoChildren(入力)

リンク先の文書空間オブジェクトの削除を指定します。trueを指定すると，リンク先の文書空間オブジェクトが削除されます。この場合，直接型リンクが設定されている下位のすべての文書空間オブジェクトが削除されます。falseを指定すると，リンク先の文書空間オブジェクトは削除されません。

(4)　戻り値

削除されたリスト要素の各DbjObjインターフェースのリスト

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjLastVersionException

最後のバージョンを削除しようとした場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.5.6　setPropSet（要素のプロパティ値集合の設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

Proxyオブジェクトのプロパティ値集合の全要素に，指定したプロパティ値集合の内容をコピーして設定します。

(2)　形式

void setPropSet(
    DbjPropSet     propSet
)

(3)　引数

propSet（入力）

プロパティ値集合インターフェースを指定します。nullを指定すると，オブジェクトのプロパティ値集合には空値が仮定されます。

(4)　戻り値

なし

(5)　例外

なし

4.5.7　writeProperties（複数の文書空間オブジェクトプロパティ値の一括設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リスト要素のProxyオブジェクトのアクセス対象である文書空間オブジェクトのプロパティを一括して設定します。

形式１では，要素のアクセス対象である文書空間オブジェクトのプロパティを，指定したプロパティ値集合で設定します。この場合，要素のProxyオブジェクトのプロパティ値集合は無視されます。形式２および形式３では，要素のアクセス対象である文書空間オブジェクトのプロパティを各要素のProxyオブジェクトに設定されたプロパティ値集合で設定します。形式2では，DbjObj#readPropertiesメソッドで読み込んだプロパティ値集合のプロパティ値を書き換えて文書空間オブジェクトのプロパティ値を更新します。形式３では，Proxyオブジェクトに設定されているプロパティのうち，要素のアクセス対象である文書空間オブジェクトに反映するプロパティを限定して指定できます。なお，形式３の場合，指定した引数の値によってProxyオブジェクトの保持するプロパティ値集合は変更されません。

(2)　形式

(a)　形式1

void writeProperties(
    DbjPropSet     propSet
)

(b)　形式2

void writeProperties()

(c)　形式3

void writeProperties(
    Collection     propdef
)

(3)　引数

propSet（入力）

文書空間オブジェクトに設定するプロパティ値集合を指定します。nullを指定すると例外がスローされます。

propDefs（入力）

要素はプロパティ名（String型）です。文書空間オブジェクトに設定する対象のプロパティ値のコレクションを指定します。nullを指定すると例外がスローされます。

(4)　戻り値

なし

(5)　例外

DbjAccessControlException

アクセス権エラーの場合

DbjACEOperationException

指定ACEについてのエラーの場合

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalPropValException

指定プロパティ値が不正の場合

DbjNotCheckOutException

チェックアウトされていないオブジェクトに対して仮のバージョン識別子が指定された場合

DbjObjectNotFoundException

指定オブジェクトが存在しなかった場合

DbjPublicACLNotFoundException

指定パブリックACLは存在しなかった場合

DbjPublicACLOutOfRangeException

指定パブリックACL数が範囲を超えた場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propSet，またはpropDefsがnullの場合

4.6　DbjSessionインターフェース

DbjSessionインターフェースは，Java クラスライブラリのセッションを扱います。Java クラスライブラリの一つのセッションオブジェクトは文書空間への一つの接続に対応し，その接続している期間をセッションといいます。DbjSessionインターフェースは，同時に一つのセッションのセッション管理をサポートします。ユーザアプリケーションプログラムが複数のセッションを実現するためには，複数のDbjSessionインターフェースを扱う必要があります。

以降，DbjSessionインターフェースのメソッドについて説明します。

＜この節の構成＞

4.6.1　begin（トランザクションの開始）

4.6.2　checkSession（セッションが有効かどうかのチェック）

4.6.3　commit（トランザクションの確定）

4.6.4　getLoginUserInfo（ユーザ情報の取得）

4.6.5　getReferencePath（コンテンツ格納先ベースパスの取得）

4.6.6　login（ログイン）

4.6.7　logout（ログアウト）

4.6.8　rollback（トランザクションの取り消し）

4.6.9　setReferencePath（コンテンツ格納先ベースパスの設定）

4.6.1　begin（トランザクションの開始）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トランザクションを開始します。このメソッドを二重に実行した場合は例外がスローされます。

(2)　形式

void begin()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalStateException

DbjSession#beginメソッドが二重に実行された場合

4.6.2　checkSession（セッションが有効かどうかのチェック）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

接続中の文書空間に対して有効なセッションがあるかどうかを調べます。無効なセッションを次に示します。

切断（logout）しているセッション

確立（login）していないセッション

文書空間との接続がタイムアウトしているセッション

(2)　形式

boolean checkSession()

(3)　引数

なし

(4)　戻り値

true

有効なセッションです。※

false

無効なセッションです。

注※

本メソッドはセッションのアイドル時間をリセットしません。そのため，セッションタイムアウトの設定をしている場合，次のメソッド発行までの間にセッションがタイムアウトする可能性があります。

(5)　例外

なし

4.6.3　commit（トランザクションの確定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トランザクションを確定します。トランザクションが開始されていない場合，例外がスローされます。

(2)　形式

void commit()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

IllegalStateException

DbjSession#beginメソッドが実行されていないのにDbjSession#commitメソッドが実行された場合

4.6.4　getLoginUserInfo（ユーザ情報の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ログインしているユーザのユーザ情報を取得します。

(2)　形式

DbjPropSet getLoginUserInfo(
    Collection     propDefs
)

(3)　引数

propDefs（入力）

要素はプロパティ名（String型）です。取得したいユーザ情報プロパティのプロパティ名を指定します。

(4)　戻り値

ユーザ情報プロパティ値集合

(5)　例外

DbjAccessControlNotSupportedException

接続先の文書空間がアクセス制御動作モードに対応していなかった場合

DbjCORBAException

CORBAエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

NullPointerException

引数propDefsがnullの場合

4.6.5　getReferencePath（コンテンツ格納先ベースパスの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル管理機能を使用して，コンテンツを任意の領域に格納する場合，DbjSession#setReferencePathメソッドで設定したコンテンツ格納先ベースパスを取得します。

(2)　形式

String getReferencePath()

(3)　引数

なし

(4)　戻り値

リファレンスファイル管理機能のコンテンツ格納先ベースパス

(5)　例外

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.6.6　login（ログイン）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間にログインしてセッションを確立し，同時にユーザ識別子およびパスワードの認証を実行して，文書空間インターフェース（DbjDocSpaceインターフェース）を取得します。このメソッドは，一つの文書空間にアクセスするほかのメソッドの実行前に実行する必要があります。確立しているセッションの有効期限は，DbjSession#logoutメソッドを実行するまで，または文書空間への接続をタイムアウト（DocumentBrokerサーバで設定される）するまでです。なお，ユーザ認証の失敗，および二重のログインがあった場合は，例外がスローされます。

(2)　形式

DbjDocSpace login(
   String       userName,
   String       passWord
)

(3)　引数

userName（入力）

ログインするユーザのユーザ識別子を指定します。

passWord（入力）

ログインするユーザのパスワードを指定します。

(4)　戻り値

文書空間オブジェクトアクセスインターフェース（DbjDocSpaceインターフェース）

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIllegalDocSpaceIdException

接続先の文書空間識別子が不正の場合

DbjNotAuthenticatedException

認証エラーの場合

DbjSessionOverflowException

セッション数が同時に接続できる数を超えた場合

IllegalStateException

すでにログインしていた場合

4.6.7　logout（ログアウト）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間からログアウトしてセッションを切断します。セッションの切断によって，ログインセッション内で継続されて使用される内部データ（検索結果キャッシュなど）は消去されます。また，切断するセッションに未確定のトランザクションがある場合は，自動的にトランザクションが取り消されて最後にトランザクションが確定された状態まで戻ります。なお，このメソッドのエラーは，エラーログファイルに出力されます。

(2)　形式

void logout()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

4.6.8　rollback（トランザクションの取り消し）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トランザクションを取り消して，最後にDbjSession#commitメソッドが実行された状態まで戻します。トランザクションが開始されていなくても正常終了します。

(2)　形式

void rollback()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

DbjCORBAException

CORBAエラーの場合

DbjDBException

DBエラーの場合

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.6.9　setReferencePath（コンテンツ格納先ベースパスの設定）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

リファレンスファイル管理機能を使用して，コンテンツを任意の領域に格納する場合に，コンテンツ格納先ベースパスを設定します。

(2)　形式

void setReferencePath( String referencePath )

(3)　引数

referencePath（入力）

リファレンスファイル管理機能で，コンテンツの格納先となるベースパスを指定します。

(4)　戻り値

なし

(5)　例外

DbjException

Java クラスライブラリ固有のエラーの場合

DbjSessionNotConnectException

セッションが接続されていなかった場合

4.7　DbjVerObjインターフェース

DbjVerObjインターフェースは，一つの文書空間オブジェクトへのアクセスを扱うことに加えて，Proxyオブジェクトのターゲットオブジェクトであるバージョンオブジェクトのバージョン識別子を扱うインターフェースです。

スーパーインターフェース

DbjObj

プロパティ一覧

DbjVerObjインターフェースが扱うプロパティとgetterメソッドを次の表に示します。

表4-3　DbjVerObjインターフェースで扱うプロパティ

プロパティ名 | データ型 | getterメソッド
バージョン識別子 | String | getVersionId

以降，DbjVerObjインターフェースのメソッドについて説明します。

＜この節の構成＞

4.7.1　getVersionId（文書空間オブジェクトのバージョン識別子の取得）

4.7.1　getVersionId（文書空間オブジェクトのバージョン識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間オブジェクトに設定されているProxyオブジェクトのターゲットオブジェクトであるバージョンオブジェクトのバージョン識別子のプロパティ値（String型）を取得します。

(2)　形式

String getVersionId()

(3)　引数

なし

(4)　戻り値

バージョンオブジェクトのバージョン識別子のプロパティ値（versionIdフィールドの値）

(5)　例外

なし

4.8　DbjVerObjListインターフェース

DbjVerObjListインターフェースは，DbjVerObjインターフェースを要素とするリストインターフェースを扱います。

スーパーインターフェース

DbjObjList

以降，DbjVerObjListインターフェースのメソッドについて説明します。

＜この節の構成＞

4.8.1　getVerObj（要素のDbjVerObjインターフェースの取得）

4.8.2　getVersionIdList（文書空間オブジェクトのバージョン識別子リストの取得）

4.8.1　getVerObj（要素のDbjVerObjインターフェースの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

インデクスで指定された要素のDbjVerObjインターフェースを取得します。

(2)　形式

DbjVerObj getVerObj(
    int     index
)

(3)　引数

index（入力）

要素インデクスを指定します。

(4)　戻り値

要素のDbjVerObjインターフェース

(5)　例外

ClassCastException

指定要素がDbjObjインターフェースでなかった場合

IndexOutOfBoundException

指定したインデクスが不正の場合

4.8.2　getVersionIdList（文書空間オブジェクトのバージョン識別子リストの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間オブジェクトが保持する要素すべてについて，Proxyオブジェクトのターゲットオブジェクトであるバージョンオブジェクトのバージョン識別子のプロパティ値をリストで取得します。

(2)　形式

List getVersionIdList()

(3)　引数

なし

(4)　戻り値

バージョンオブジェクトのバージョン識別子のプロパティ値（versionIdフィールドの値）のリスト（String型のリスト）

(5)　例外

ClassCastException

指定要素がDbjObjインターフェースでなかった場合

4.9　DbjXmlTranslatorインターフェース

DbjXmlTranslatorインターフェースは，XML文書のXMLプロパティマッピング機能を扱います。

以降，DbjXmlTranslatorインターフェースのメソッドについて説明します。

＜この節の構成＞

4.9.1　getMappedProperties（XML文書のXMLプロパティマッピング情報の作成）

4.9.1　getMappedProperties（XML文書のXMLプロパティマッピング情報の作成）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

XML文書を解析して，マッピング定義情報に従ってXML文書からプロパティを抽出して文書のプロパティなどの情報を作成します。

(2)　形式

DbjMappedProp getMappedProperties(
    String          filePath,
    int             parseLevel,
    String          mappingId
)

(3)　引数

filePath（入力）

XML文書ファイルのローカルパスを絶対パスで指定します。nullを指定すると例外がスローされます。

parseLevel（入力）

構文解析のレベルを指定します。次のどれかを指定できます。

DbjDef.XMLPARSE_NO_EXTERNAL_ENTITIES
DTDの解析をしないで，外部エンティティは無視します。

DbjDef.XMLPARSE_WITH_EXTERNAL_ENTITIES
DTDを含めた構文解析をして外部エンティティを読み込みますが，検証を実行しません。

DbjDef.XMLPARSE_VALIDATE
DTDを使用して検証を実行します

mappingId（入力）

マッピング定義名を指定します。nullを指定すると例外がスローされます。

(4)　戻り値

DbjMappedPropインターフェース

(5)　例外

DbjException

Java クラスライブラリ固有のエラーの場合

DbjIOException

Java クラスライブラリ固有のIOエラーの場合

DbjXmlParseException

XMLファイルの構文解析エラーの場合

NullPointerException

引数filePath，またはmappingIdがnullの場合

5.　メタクラス詳細

この章では，メタクラスのインターフェース，およびメソッドについて説明します。

＜この章の構成＞

5.1　DbjClassDescインターフェース

5.2　DbjMetaインターフェース

5.3　DbjMetaManagerインターフェース

5.4　DbjPropDescインターフェース

5.1　DbjClassDescインターフェース

DbjClassDescインターフェースは，一つの文書空間オブジェクトクラスのメタ情報（クラスディスクリプション）を扱うインターフェースです。

以降，DbjClassDescインターフェースのメソッドについて説明します。

＜この節の構成＞

5.1.1　getName（クラス名の取得）

5.1.2　getProperties（プロパティディスクリプションの取得）

5.1.3　getSubClasses（サブクラスのクラスディスクリプションの取得）

5.1.4　getSuperClass（スーパークラスのクラスディスクリプションの取得）

5.1.1　getName（クラス名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

クラス名を取得します。

(2)　形式

String getName()

(3)　引数

なし

(4)　戻り値

クラス名

(5)　例外

なし

5.1.2　getProperties（プロパティディスクリプションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

クラスが保持するプロパティディスクリプションをすべて取得します。

(2)　形式

List getProperties()

(3)　引数

なし

(4)　戻り値

プロパティディスクリプション（DbjPropDescインターフェース）を要素とするリスト

(5)　例外

なし

5.1.3　getSubClasses（サブクラスのクラスディスクリプションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

直接のサブクラスのクラスディスクリプションをすべて取得します。

サブクラスがない場合は，要素が空のリストが返却されます。

(2)　形式

List getSubClasses()

(3)　引数

なし

(4)　戻り値

クラスディスクリプション（DbjClassDescインターフェース）を要素とするリスト

(5)　例外

なし

5.1.4　getSuperClass（スーパークラスのクラスディスクリプションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

直接のスーパークラスのクラスディスクリプションを取得します。

スーパークラスがない場合は，nullが返却されます。

(2)　形式

DbjClassDesc getSuperClass()

(3)　引数

なし

(4)　戻り値

スーパークラスのクラスディスクリプション（DbjClassDescインターフェース）

(5)　例外

なし

5.2　DbjMetaインターフェース

DbjMetaインターフェースは，一つの文書空間のメタ情報を扱うインターフェースです。

以降，DbjMetaインターフェースのメソッドについて説明します。

＜この節の構成＞

5.2.1　getClassDesc（指定したクラスのクラスディスクリプションの取得）

5.2.2　getDocSpaceId（文書空間識別子の取得）

5.2.3　getExtFromRenditionType（レンディションタイプに対応する拡張子の取得）

5.2.4　getPropDataType（指定したプロパティのデータ型の取得）

5.2.5　getPropDesc（指定したプロパティのプロパティディスクリプションの取得）

5.2.6　getRenditionType（拡張子に対応するレンディションタイプの取得）

5.2.1　getClassDesc（指定したクラスのクラスディスクリプションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したクラスのクラスディスクリプションを取得します。

(2)　形式

DbjClassDesc getClassDesc(
    String              className
)

(3)　引数

className（入力）

クラス名を指定します。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

指定したクラスのクラスディスクリプション（DbjClassDescインターフェース）

(5)　例外

IllegalArgumentException

指定したクラスがなかった場合

NullPointerException

引数classNameにnullを指定した場合

5.2.2　getDocSpaceId（文書空間識別子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

文書空間識別子を取得します。

(2)　形式

String getDocSpaceId()

(3)　引数

なし

(4)　戻り値

文書空間識別子

(5)　例外

なし

5.2.3　getExtFromRenditionType（レンディションタイプに対応する拡張子の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

レンディション定義ファイルの定義内容に従って，指定したレンディションタイプに対応する拡張子を取得します。

指定したレンディションタイプがレンディション定義ファイルに定義されていない場合は，nullが返却されます。また，指定したレンディションタイプに対応する拡張子が複数定義されている場合は，その中のどれかの拡張子が返却されます。

(2)　形式

String getExtFromRenditionType(
    String                  renditionType
)

(3)　引数

renditionType（入力）

レンディションタイプを指定します。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

指定したレンディションタイプに対応する拡張子

(5)　例外

NullPointerException

引数renditionTypeにnullを指定した場合

5.2.4　getPropDataType（指定したプロパティのデータ型の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティのデータ型を取得します。

(2)　形式

int getPropDataType(
    String        propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

指定したプロパティのデータ型が，次に示す定数で返却されます。

DbjDef.DATATYPE_BOOL
BOOL型

DbjDef.DATATYPE_INT
INT型

DbjDef.DATATYPE_STR
STR型

DbjDef.DATATYPE_STRLIST
STRLIST型

DbjDef.DATATYPE_VARRAY
VARRAY型

(5)　例外

IllegalArgumentException

指定したプロパティがなかった場合

NullPointerException

引数propNameにnullを指定した場合

5.2.5　getPropDesc（指定したプロパティのプロパティディスクリプションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定したプロパティのプロパティディスクリプションを取得します。

(2)　形式

DbjPropDesc getPropDesc(
    String            propName
)

(3)　引数

propName（入力）

プロパティ名を指定します。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

指定したプロパティのプロパティディスクリプション（DbjPropDescインターフェース）

(5)　例外

IllegalArgumentException

指定したプロパティがなかった場合

NullPointerException

引数propNameにnullを指定した場合

5.2.6　getRenditionType（拡張子に対応するレンディションタイプの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

レンディション定義ファイルの定義内容に従って，指定した拡張子に対応するレンディションタイプを取得します。

指定した拡張子に対応するレンディションタイプがレンディション定義ファイルに定義されていない場合は，nullが返却されます。

(2)　形式

String getRenditionType(
    String            extension
)

(3)　引数

extension（入力）

ファイルの拡張子を指定します。指定する拡張子の先頭に「.」（ピリオド）は不要です。

nullを指定した場合は，例外がスローされます。

(4)　戻り値

指定した拡張子に対応するレンディションタイプ（「MIME::」は含みません）

(5)　例外

NullPointerException

引数extensionにnullを指定した場合

5.3　DbjMetaManagerインターフェース

DbjMetaManagerインターフェースは，文書空間のメタ情報を管理するためのインターフェースです。

以降，DbjMetaManagerインターフェースのメソッドについて説明します。

＜この節の構成＞

5.3.1　getMeta（メタ情報の取得）

5.3.1　getMeta（メタ情報の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

指定した文書空間のメタ情報を取得します。メタ情報はDbjMetaインターフェースで返却されます。

なお，メタ情報を取得するには，クラス定義情報ファイルをあらかじめ作成して，決められたディレクトリ下に格納しておく必要があります。クラス定義情報ファイルの作成方法および格納先については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「7.6.1　クラス定義情報ファイル」を参照してください。

(2)　形式

DbjMeta getMeta(
    String    docspaceId
)

(3)　引数

docspaceId（入力）

文書空間識別子をGUID文字列で指定します。GUID文字列は，16進数「X」によって，「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8けた-4けた-4けた-4けた-12けた）」の形式で表されます。「X」は，0～9，a～f（小文字），およびA～F（大文字）のどれかです。nullを指定した場合は，例外がスローされます。

(4)　戻り値

指定した文書空間のメタ情報（DbjMetaインターフェース）

(5)　例外

IllegalArgumentException

指定した文書空間がなかった場合

NullPointerException

引数docspaceIdにnullを指定した場合

5.4　DbjPropDescインターフェース

DbjPropDescインターフェースは，文書空間オブジェクトの一つのプロパティのメタ情報（プロパティディスクリプション）を扱うインターフェースです。

以降，DbjPropDescインターフェースのメソッドについて説明します。

＜この節の構成＞

5.4.1　getDataType（プロパティのデータ型の取得）

5.4.2　getName（プロパティ名の取得）

5.4.3　getVArrayClass（VARRAY型プロパティを扱うクラスのクラスディスクリプションの取得）

5.4.1　getDataType（プロパティのデータ型の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

プロパティのデータ型を取得します。

(2)　形式

int getDataType()

(3)　引数

なし

(4)　戻り値

プロパティのデータ型が，次に示す定数で返却されます。

DbjDef.DATATYPE_BOOL
BOOL型

DbjDef.DATATYPE_INT
INT型

DbjDef.DATATYPE_STR
STR型

DbjDef.DATATYPE_STRLIST
STRLIST型

DbjDef.DATATYPE_VARRAY
VARRAY型

(5)　例外

なし

5.4.2　getName（プロパティ名の取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

プロパティ名を取得します。

(2)　形式

String getName()

(3)　引数

なし

(4)　戻り値

プロパティ名

(5)　例外

なし

5.4.3　getVArrayClass（VARRAY型プロパティを扱うクラスのクラスディスクリプションの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

VARRAY型プロパティを扱うクラスのクラスディスクリプションを取得します。

VARRAY型プロパティを扱うクラスでない場合は，nullが返却されます。

(2)　形式

DbjClassDesc getVArrayClass()

(3)　引数

なし

(4)　戻り値

VARRAY型プロパティを扱うクラスのクラスディスクリプション（DbjClassDescインターフェース）

(5)　例外

なし

6.　例外クラス詳細

この章では，例外クラスのクラスについて説明します。

＜この章の構成＞

6.1　例外クラスの詳細

6.2　DbjAccessControlExceptionクラス

6.3　DbjAccessControlNotSupportedExceptionクラス

6.4　DbjACEOperationExceptionクラス

6.5　DbjACLOutOfRangeExceptionクラス

6.6　DbjAlreadyCheckOutExceptionクラス

6.7　DbjCheckOutExceptionクラス

6.8　DbjContentNotRegisteredExceptionクラス

6.9　DbjContentTypeMismatchExceptionクラス

6.10　DbjCORBAExceptionクラス

6.11　DbjDBDeadLockExceptionクラス

6.12　DbjDBExceptionクラス

6.13　DbjDBLockTimeoutExceptionクラス

6.14　DbjDisconnectedSessionExceptionクラス

6.15　DbjErrorクラス

6.16　DbjExceptionクラス

6.17　DbjFileAccessExceptionクラス

6.18　DbjFileNotFoundExceptionクラス

6.19　DbjFileReferenceCurrentContentNotfoundExceptionクラス

6.20　DbjFileReferenceMismatchStatusExceptionクラス

6.21　DbjFileReferenceOperationFailedExceptionクラス

6.22　DbjIllegalCacheStartIndexExceptionクラス

6.23　DbjIllegalDocSpaceIdExceptionクラス

6.24　DbjIllegalObjectTypeExceptionクラス

6.25　DbjIllegalPropValExceptionクラス

6.26　DbjInitializeErrorクラス

6.27　DbjInternalErrorクラス

6.28　DbjIOExceptionクラス

6.29　DbjIsMasterRenditionExceptionクラス

6.30　DbjLastVersionExceptionクラス

6.31　DbjMasterRenditionNotSetExceptionクラス

6.32　DbjNotAuthenticatedExceptionクラス

6.33　DbjNotCheckOutExceptionクラス

6.34　DbjNotLoginExceptionクラス

6.35　DbjObjectNotFoundExceptionクラス

6.36　DbjOutOfMemoryErrorクラス

6.37　DbjPublicACLAlreadyBoundExceptionクラス

6.38　DbjPublicACLNotBoundExceptionクラス

6.39　DbjPublicACLNotFoundExceptionクラス

6.40　DbjPublicACLOperationExceptionクラス

6.41　DbjPublicACLOutOfRangeExceptionクラス

6.42　DbjReferenceTypeMismatchExceptionクラス

6.43　DbjRenditionCountOutOfRangeExceptionクラス

6.44　DbjRenditionIsEmptyExceptionクラス

6.45　DbjRenditionNotConvertedExceptionクラス

6.46　DbjRenditionNotFoundExceptionクラス

6.47　DbjRenditionTypeDuplicatedExceptionクラス

6.48　DbjSessionExceptionクラス

6.49　DbjSessionNotConnectExceptionクラス

6.50　DbjSessionOverflowExceptionクラス

6.51　DbjSubjectLengthOutOfRangeExceptionクラス

6.52　DbjTargetContentPathNotSetExceptionクラス

6.53　DbjUnknownErrorクラス

6.54　DbjXmlParseExceptionクラス

6.1　例外クラスの詳細

Java クラスライブラリのAPIでエラーが発生すると，例外がスローされます。例外クラスは，Java クラスライブラリ固有の例外を扱うクラス群です。ここでは，それぞれの例外クラスの機能，例外クラスのスーパークラス，メソッド（コンストラクタ）一覧を説明します。なお，例外クラスのコンストラクタについては，「1.5.3　例外クラスのコンストラクタ」を参照してください。

6.2　DbjAccessControlExceptionクラス

DbjAccessControlExceptionクラスは，ユーザのメソッドの実行時に，その操作に対してユーザにアクセス権がない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjAccessControlException()

DbjAccessControlException(String s)

6.3　DbjAccessControlNotSupportedExceptionクラス

DbjAccessControlNotSupportedExceptionクラスは，文書空間がアクセス制御機能に対応していない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjAccessControlNotSupportedException()

DbjAccessControlNotSupportedException(String s)

6.4　DbjACEOperationExceptionクラス

DbjACEOperationExceptionクラスは，ACEの操作エラーを表すスーパークラスです。特定のACE操作のエラーは，サブクラスがスローされます。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjACEOperationException()

DbjACEOperationException(String s)

6.5　DbjACLOutOfRangeExceptionクラス

DbjACLOutOfRangeExceptionクラスは，文書空間オブジェクトのACEの個数が制限値を超えて追加された場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjACEOperationException

(2)　コンストラクタ一覧

DbjACLOutOfRangeException()

DbjACLOutOfRangeException(String s)

6.6　DbjAlreadyCheckOutExceptionクラス

DbjAlreadyCheckOutExceptionクラスは，すでにチェックアウトされている場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjCheckOutException

(2)　コンストラクタ一覧

DbjAlreadyCheckOutException()

DbjAlreadyCheckOutException(String s)

6.7　DbjCheckOutExceptionクラス

DbjCheckOutExceptionクラスは，チェックアウトについてのエラーを表すスーパークラスです。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjCheckOutException()

DbjCheckOutException(String s)

6.8　DbjContentNotRegisteredExceptionクラス

DbjContentNotRegisteredExceptionクラスは，リファレンスファイル管理機能を使用したオブジェクトをローカルファイルにダウンロードする場合に，オブジェクトにコンテンツが登録されていないときのエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjContentNotRegisteredException()

DbjContentNotRegisteredException(String s)

6.9　DbjContentTypeMismatchExceptionクラス

DbjContentTypeMismatchExceptionクラスは，リファレンスファイル管理機能で，オブジェクトのコンテンツ種別とメソッドが要求するコンテンツ種別が一致しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjContentTypeMismatchException()

DbjContentTypeMismatchException(String s)

6.10　DbjCORBAExceptionクラス

DbjCORBAExceptionクラスは，CORBAエラー（TPBrokerでのエラー）を表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjCORBAException()

DbjCORBAException(String s)

6.11　DbjDBDeadLockExceptionクラス

DbjDBDeadLockExceptionクラスは，DBのデッドロックエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjDBException

(2)　コンストラクタ一覧

DbjDBDeadLockException()

DbjDBDeadLockException(String s)

6.12　DbjDBExceptionクラス

DbjDBExceptionクラスは，DBエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjDBException()

DbjDBException(String s)

6.13　DbjDBLockTimeoutExceptionクラス

DbjDBLockTimeoutExceptionクラスは，DBのロックタイムアウトエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjDBException

(2)　コンストラクタ一覧

DbjDBLockTimeoutException()

DbjDBLockTimeoutException(String s)

6.14　DbjDisconnectedSessionExceptionクラス

DbjDisconnectedSessionExceptionクラスは，文書空間との接続が切断された場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjSessionNotConnectException

(2)　コンストラクタ一覧

DbjDisconnectedSessionException()

DbjDisconnectedSessionException(String s)

6.15　DbjErrorクラス

DbjErrorクラスはjava.lang.Errorクラスを継承し，Java クラスライブラリ固有の致命的なエラーを表すスーパークラスです。メモリ不足，Java クラスライブラリの初期化エラー，Java クラスライブラリ内で予期しない内部エラーが発生した場合のエラーなど，ユーザアプリケーションプログラムで対処できないエラーを表します。

DbjErrorクラスに関連付けられたエラーメッセージは次の内容を含みます。

エラー内容，または原因コード

エラー発生メソッド

エラー発生個所（ソース行番号，ソースファイル名）

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

java.lang.Error

(2)　コンストラクタ一覧

DbjError()

DbjError(String s)

6.16　DbjExceptionクラス

DbjExceptionクラスはjava.lang.Exceptionクラスを継承し，Java クラスライブラリ固有のエラーを表すスーパークラスです。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

java.lang.Exception

(2)　コンストラクタ一覧

DbjException()

DbjException(String s)

6.17　DbjFileAccessExceptionクラス

DbjFileAccessExceptionクラスは，ファイルのアクセス権がない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjIOException

(2)　コンストラクタ一覧

DbjFileAccessException()

DbjFileAccessException(String s)

6.18　DbjFileNotFoundExceptionクラス

DbjFileNotFoundExceptionクラスは，指定ファイルが存在しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjIOException

(2)　コンストラクタ一覧

DbjFileNotFoundException()

DbjFileNotFoundException(String s)

6.19　DbjFileReferenceCurrentContentNotfoundExceptionクラス

DbjFileReferenceCurrentContentNotfoundExceptionクラスは，リファレンスファイル管理機能を使用したバージョン付きの文書オブジェクトで，カレントバージョンにコンテンツが存在しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjFileReferenceCurrentContentNotfoundException()

DbjFileReferenceCurrentContentNotfoundException(String s)

6.20　DbjFileReferenceMismatchStatusExceptionクラス

DbjFileReferenceMismatchStatusExceptionクラスは，リファレンスファイル管理機能を使用するサーバでのコンテンツ操作でエラーが発生し，オブジェクトとコンテンツが不整合な状態になった場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjFileReferenceMismatchStatusException()

DbjFileReferenceMismatchStatusException(String s)

6.21　DbjFileReferenceOperationFailedExceptionクラス

DbjFileReferenceOperationFailedExceptionクラスは，リファレンスファイル管理機能を使用するサーバでのコンテンツ操作が失敗した場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjFileReferenceOperationFailedException()

DbjFileReferenceOperationFailedException(String s)

6.22　DbjIllegalCacheStartIndexExceptionクラス

DbjIllegalCacheStartIndexExceptionクラスは，キャッシュ検索時に検索結果より大きい値をDbjFetchInfoインターフェースのstartIndexプロパティへ指定した場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjIlleaglCacheStartIndexException()

DbjIlleaglCacheStartIndexException(String s)

6.23　DbjIllegalDocSpaceIdExceptionクラス

DbjIllegalDocSpaceIdExceptionクラスは，不正な文書空間識別子が指定された場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjIllegalDocSpaceIdException()

DbjIllegalDocSpaceIdException(String s)

6.24　DbjIllegalObjectTypeExceptionクラス

DbjIllegalObjectTypeExceptionクラスは，メソッドによる操作に不適切な文書空間オブジェクト種別が指定された場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjIllegalObjectTypeException()

DbjIllegalObjectTypeException(String s)

6.25　DbjIllegalPropValExceptionクラス

DbjIllegalPropValExceptionクラスは，不正なプロパティ値を指定した場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjIllegalPropValException()

DbjIllegalPropValException(String s)

6.26　DbjInitializeErrorクラス

DbjInitializeErrorクラスは，Java クラスライブラリの初期化を実行した時のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjError

(2)　コンストラクタ一覧

DbjInitializeError()

DbjInitializeError(String s)

6.27　DbjInternalErrorクラス

DbjInternalErrorクラスは，Java クラスライブラリの内部エラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjError

(2)　コンストラクタ一覧

DbjInternalError()

DbjInternalError(String s)

6.28　DbjIOExceptionクラス

DbjIOExceptionクラスは，Java クラスライブラリ固有のIOエラーを表すスーパークラスです。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjIOException()

DbjIOException(String s)

6.29　DbjIsMasterRenditionExceptionクラス

DbjIsMasterRenditionExceptionクラスは，マスタレンディションが指定された場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjIsMasterRenditionException()

DbjIsMasterRenditionException(String s)

6.30　DbjLastVersionExceptionクラス

DbjLastVersionExceptionクラスは，操作対象となるバージョン付きオブジェクトの最後の１バージョンを削除しようとした場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjLastVersionException()

DbjLastVersionException(String s)

6.31　DbjMasterRenditionNotSetExceptionクラス

DbjMasterRenditionNotSetExceptionクラスは，マスタレンディションのレンディションタイプが設定されていない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjMasterRenditionNotSetException()

DbjMasterRenditionNotSetException(String s)

6.32　DbjNotAuthenticatedExceptionクラス

DbjNotAuthenticatedExceptionクラスは，ユーザ認証エラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjNotAuthenticatedException()

DbjNotAuthenticatedException(String s)

6.33　DbjNotCheckOutExceptionクラス

DbjNotCheckOutExceptionクラスは，チェックアウトされていない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjCheckOutException

(2)　コンストラクタ一覧

DbjNotCheckOutException()

DbjNotCheckOutException(String s)

6.34　DbjNotLoginExceptionクラス

DbjNotLoginExceptionクラスは，文書空間にログインされていない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjSessionNotConnectException

(2)　コンストラクタ一覧

DbjNotLoginException()

DbjNotLoginException(String s)

6.35　DbjObjectNotFoundExceptionクラス

DbjObjectNotFoundExceptionクラスは，操作対象となる文書空間オブジェクトがメソッド実行にすでに削除されていた場合，または存在しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjObjectNotFoundException()

DbjObjectNotFoundException(String s)

6.36　DbjOutOfMemoryErrorクラス

DbjOutOfMemoryErrorクラスは，メモリ不足が発生したことを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjError

(2)　コンストラクタ一覧

DbjOutOfMemoryError()

DbjOutOfMemoryError(String s)

6.37　DbjPublicACLAlreadyBoundExceptionクラス

DbjPublicACLAlreadyBoundExceptionクラスは，指定したパブリックACLがすでにバインドされている場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjPublicACLOperationException

(2)　コンストラクタ一覧

DbjPublicACLAlreadyBoundException()

DbjPublicACLAlreadyBoundException(String s)

6.38　DbjPublicACLNotBoundExceptionクラス

DbjPublicACLNotBoundExceptionクラスは，指定したパブリックACLがバインドされていない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjPublicACLOperationException

(2)　コンストラクタ一覧

DbjPublicACLNotBoundException()

DbjPublicACLNotBoundException(String s)

6.39　DbjPublicACLNotFoundExceptionクラス

DbjPublicACLNotFoundExceptionクラスは，指定したパブリックACLが存在しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjPublicACLOperationException

(2)　コンストラクタ一覧

DbjPublicACLNotFoundException()

DbjPublicACLNotFoundException(String s)

6.40　DbjPublicACLOperationExceptionクラス

DbjPublicACLOperationExceptionクラスは，パブリックACLの操作エラーを表すスーパークラスです。特定のパブリックACL操作のエラーには，サブクラスがスローされます。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjPublicACLOperationException()

DbjPublicACLOperationException(String s)

6.41　DbjPublicACLOutOfRangeExceptionクラス

DbjPublicACLOutOfRangeExceptionクラスは，文書空間オブジェクトのパブリックACLの個数が制限値を超えて追加された場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjPublicACLOperationException

(2)　コンストラクタ一覧

DbjPublicACLOutOfRangeException()

DbjPublicACLOutOfRangeException(String s)

6.42　DbjReferenceTypeMismatchExceptionクラス

DbjReferenceTypeMismatchExceptionクラスは，リファレンスファイル管理機能で，オブジェクトのリファレンス種別とメソッドが要求するリファレンス種別が一致しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjReferenceTypeMismatchException()

DbjReferenceTypeMismatchException(String s)

6.43　DbjRenditionCountOutOfRangeExceptionクラス

DbjRenditionCountOutOfRangeExceptionクラスは，レンディション数が制限値を超えた場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjRenditionCountOutOfRangeException()

DbjRenditionCountOutOfRangeException(String s)

6.44　DbjRenditionIsEmptyExceptionクラス

DbjRenditionIsEmptyExceptionクラスは，レンディションが空の場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjRenditionIsEmptyException()

DbjRenditionIsEmptyException(String s)

6.45　DbjRenditionNotConvertedExceptionクラス

DbjRenditionNotConvertedExceptionクラスは，レンディションが更新処理されていない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjRenditionNotConvertedException()

DbjRenditionNotConvertedException(String s)

6.46　DbjRenditionNotFoundExceptionクラス

DbjRenditionNotFoundExceptionクラスは，指定レンディションが存在しない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjRenditionNotFoundException()

DbjRenditionNotFoundException(String s)

6.47　DbjRenditionTypeDuplicatedExceptionクラス

DbjRenditionTypeDuplicatedExceptionクラスは，レンディションタイプが重複している場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjRenditionTypeDuplicatedException()

DbjRenditionTypeDuplicatedException(String s)

6.48　DbjSessionExceptionクラス

DbjSessionExceptionクラスは，セッションについてのエラーを表すスーパークラスです。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjSessionException()

DbjSessionException(String s)

6.49　DbjSessionNotConnectExceptionクラス

DbjSessionNotConnectExceptionクラスは，文書空間と接続されていない場合のエラーを表すスーパークラスです。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjSessionException

(2)　コンストラクタ一覧

DbjSessionNotConnectException()

DbjSessionNotConnectException(String s)

6.50　DbjSessionOverflowExceptionクラス

DbjSessionOverflowExceptionクラスは，文書空間への同時接続数が制限値を超えた場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjSessionException

(2)　コンストラクタ一覧

DbjSessionOverflowException()

DbjSessionOverflowException(String s)

6.51　DbjSubjectLengthOutOfRangeExceptionクラス

DbjSubjectLengthOutOfRangeExceptionクラスは，ACEのサブジェクトの長さが制限値を超えた場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjACEOperationException

(2)　コンストラクタ一覧

DbjSubjectLengthOutOfRangeException()

DbjSubjectLengthOutOfRangeException(String s)

6.52　DbjTargetContentPathNotSetExceptionクラス

DbjTargetContentPathNotSetExceptionクラスは，リファレンスファイル管理機能で，コンテンツ格納先ベースパスが設定されていない場合のエラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjTargetContentPathNotSetException()

DbjTargetContentPathNotSetException(String s)

6.53　DbjUnknownErrorクラス

DbjUnknownErrorクラスは，Java クラスライブラリ内での未知のエラーの発生を表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjError

(2)　コンストラクタ一覧

DbjUnknownError()

DbjUnknownError(String s)

6.54　DbjXmlParseExceptionクラス

DbjXmlParseExceptionクラスは，XML文書の構文解析エラーを表します。

＜この節の構成＞

(1)　スーパークラス

(2)　コンストラクタ一覧

(1)　スーパークラス

DbjException

(2)　コンストラクタ一覧

DbjXmlParseException()

DbjXmlParseException(String s)

7.　定数定義クラス詳細

この章では，定数定義クラスの定義内容について説明します。

＜この章の構成＞

7.1　DbjDefクラス

7.2　DbjTraceDefクラス

7.1　DbjDefクラス

DbjDefクラスは，Java クラスライブラリで使用する定数を定義したクラスです。

以降，DbjDefクラスの定数定義内容について，カテゴリごとに説明します。

なお，DbjDefクラスで定義されている定数のアクセス指定子は，すべて「public」です。

＜この節の構成＞

7.1.1　Category：ACL

7.1.2　Category：DATATYPE

7.1.3　Category：DMA BOOLEAN

7.1.4　Category：INDEXTYPE

7.1.5　Category：LINK

7.1.6　Category：LOCK

7.1.7　Category：OBJTYPE

7.1.8　Category：OPERATEMODE

7.1.9　Category：ORDER

7.1.10　Category：PERM

7.1.11　Category：PRIV

7.1.12　Category：REFERENCETYPE

7.1.13　Category：RELATIONEND

7.1.14　Category：RENDSTATUS

7.1.15　Category：SUBJECTTYPE

7.1.16　Category：SYSSUBJECT

7.1.17　Category：XMLPARSE

7.1.18　Category：Others

7.1.1　Category：ACL

検索実行時のアクセス制御モードを表す定数です。アクセス制御機能付き検索を実行するか，実行しないかを表します。

検索実行時のアクセス制御モードを表す定数を表7-1に示します。

表7-1　検索実行時のアクセス制御モードを表す定数

定数 | データ型 | 意味
WITH_ACL | int型 | アクセス制御機能付き検索モード
WITHOUT_ACL | int型 | アクセス制御機能なし検索モード

7.1.2　Category：DATATYPE

文書空間オブジェクトのプロパティのデータ型を表す定数です。

文書空間オブジェクトのプロパティのデータ型を表す定数を表7-2に示します。

表7-2　文書空間オブジェクトのプロパティのデータ型を表す定数

定数 | データ型 | 意味
DATATYPE_BOOL | int型 | BOOL型
DATATYPE_INT | int型 | INT型
DATATYPE_STR | int型 | STR型
DATATYPE_STRLIST | int型 | STRLIST型
DATATYPE_VARRAY | int型 | VARRAY型
DATATYPE_UNKNOWN | int型 | 未サポートのデータ型，またはデータ型不明

7.1.3　Category：DMA BOOLEAN

BOOL型を表す定数です。

BOOL型を表す定数を表7-3に示します。

表7-3　BOOL型を表す定数

定数 | データ型 | 意味
DMA_TRUE | int型 | 真
DMA_FALSE | int型 | 偽
DMA_UNKNOWN | int型 | 不定

7.1.4　Category：INDEXTYPE

全文検索インデクスの種別を表す定数です。

全文検索インデクスの種別を表す定数を表7-4に示します。

表7-4　全文検索インデクスの種別を表す定数

定数 | データ型 | 意味
INDEXTYPE_NOTHING | int型 | 全文検索インデクスを作成しません。インデクスデータは出力されません。
INDEXTYPE_PLAIN | int型 | 構造指定検索なしの全文検索インデクスを作成します。プレーンテキスト形式のインデクスデータが出力されます。
INDEXTYPE_STRUCTURED | int型 | 構造指定検索用の全文検索インデクスを作成します。構造指定検索用のインデクスデータ（ESIS-B形式のデータ）が出力されます。

7.1.5　Category：LINK

リンク種別を表す定数です。

リンク種別を表す定数を表7-5に示します。

表7-5　リンク種別を表す定数

定数 | データ型 | 意味
LINK_DCR | int型 | 直接型リンク
LINK_RCR | int型 | 参照型リンク
LINK_VTFIX | int型 | 構成管理型リンク（構成管理モードはFIXモード）
LINK_VTFLOAT | int型 | 構成管理型リンク（構成管理モードはFLOATINGモード）
LINK_VT | int型 | 構成管理型リンク（LINK_VTFIX｜LINK_VTFLOAT）
LINK_REL | int型 | 文書間リンク
LINK_ALL | int型 | すべてのリンク種別を組み合わせたリンク
LINK_NONE | int型 | リンクなし

7.1.6　Category：LOCK

ロック種別を表す定数です。

ロック種別を表す定数を表7-6に示します。

表7-6　ロック種別を表す定数

定数 | データ型 | 意味
LOCK_READ | int型 | readロック
LOCK_WRITE | int型 | 排他的なwriteロック
LOCK_READFORUPDATE | int型 | readロック（更新または削除ができます）
LOCK_NONE | int型 | ロックなし

7.1.7　Category：OBJTYPE

オブジェクト種別を表す定数です。

オブジェクト種別を表す定数を表7-7に示します。

表7-7　オブジェクト種別を表す定数

定数 | データ型 | 意味
OBJTYPE_ANY | int型 | 任意のオブジェクト種別の論理和
OBJTYPE_NVTFOLDER | int型 | 構成管理できないバージョンなしフォルダ
OBJTYPE_DOC | int型 | バージョンなし文書
OBJTYPE_VRFOLDER | int型 | バージョン付きフォルダ
OBJTYPE_VRDOC | int型 | バージョン付き文書
OBJTYPE_FOLDER | int型 | バージョンなしフォルダ
OBJTYPE_IP | int型 | 独立データ
OBJTYPE_PUBLICACL | int型 | パブリックACL
OBJTYPE_UNKNOWN | int型 | オブジェクト種別不明

7.1.8　Category：OPERATEMODE

コンテンツのパス操作モードを表す定数です。

コンテンツのパス操作モードを表す定数を表7-8に示します。

表7-8　コンテンツのパス操作モードを表す定数

定数 | データ型 | 意味
OPERATEMODE_NONE | int型 | コンテンツがないオブジェクトを作成します。
OPERATEMODE_USER_RELATIVE_CONTENT | int型 | コンテンツロケーションをコンテンツの相対パスで管理します。

7.1.9　Category：ORDER

バージョン情報の取得順序を表す定数です。

バージョン情報の取得順序を表す定数を表7-9に示します。

表7-9　バージョン情報の取得順序を表す定数

定数 | データ型 | 意味
ORDER_ASC | int型 | 最も古いバージョンから順に取得します。
ORDER_DESC | int型 | 最も新しいバージョンから順に取得します。
ORDER_NONE | int型 | 順序を指定しません。

7.1.10　Category：PERM

パーミッションを表す定数です。

パーミッションを表す定数を表7-10に示します。

表7-10　パーミッションを表す定数

定数
データ型
意味

PERM_NONE
int型
アクセス権なし

PERM_PRIM_READ_PROPS
int型
基本プロパティ参照権

PERM_PRIM_WRITE_PROPS
int型
基本プロパティ更新権

PERM_PRIM_READ_CONTENTS
int型
基本コンテンツ参照権

PERM_PRIM_WRITE_CONTENTS
int型
基本コンテンツ更新権

PERM_PRIM_LINK
int型
基本リンク権

PERM_PRIM_VERSION
int型
基本バージョン管理権

PERM_PRIM_DELETE
int型
基本削除権

PERM_CHANGE_PERM
int型
アクセス制御情報変更権

PERM_CREATE
int型
オブジェクト作成権

PERM_READ_PROPS
int型
プロパティ参照権
次のパーミッションと等価

PERM_PRIM_READ_PROPS

PERM_READ
int型
参照権
次のパーミッションの論理和と等価

PERM_PRIM_READ_PROPS

PERM_PRIM_READ_CONTENTS

PERM_WRITE_PROPS
int型
プロパティ更新権
次のパーミッションの論理和と等価

PERM_PRIM_READ_PROPS

PERM_PRIM_WRITE_PROPS

PERM_READ_WRITE
int型
参照更新権
次のパーミッションの論理和と等価

PERM_READ

PERM_PRIM_WRITE_PROPS

PERM_PRIM_WRITE_CONTENTS

PERM_DELETE
int型
削除権
次のパーミッションの論理和と等価

PERM_PRIM_READ_PROPS

PERM_PRIM_DELETE

PERM_LINK
int型
リンク権
次のパーミッションの論理和と等価

PERM_PRIM_READ_PROPS

PERM_PRIM_LINK

PERM_VERSION
int型
バージョン権
次のパーミッションの論理和と等価

PERM_READ_WRITE

PERM_PRIM_VERSION

PERM_FULL_CONTROL
int型
フルコントロール
次のパーミッションの論理和と等価

PERM_READ_WRITE

PERM_PRIM_LINK

PERM_PRIM_VERSION

PERM_PRIM_DELETE

7.1.11　Category：PRIV

文書空間に対するユーザの特権を表す定数です。

文書空間に対するユーザの特権を表す定数を表7-11に示します。

表7-11　文書空間に対するユーザの特権を表す定数

定数 | データ型 | 意味
PRIV_NONE | int型 | セキュリティ管理者ではありません。
PRIV_SECURITY_ADMINISTRATOR | int型 | セキュリティ管理者です。

7.1.12　Category：REFERENCETYPE

リファレンス種別を表す定数です。

リファレンス種別を表す定数を表7-12に示します。

表7-12　リファレンス種別を表す定数

定数 | データ型 | 意味
REFERENCETYPE_NONE | int型 | コンテンツはありません。
REFERENCETYPE_USER_RELATIVE_CONTENT | int型 | ユーザ管理領域に格納したコンテンツ（相対パス）です。

7.1.13　Category：RELATIONEND

文書間リンク設定情報一覧の取得条件を表す定数です。

文書間リンク設定情報一覧の取得条件を表す定数を表7-13に示します。

表7-13　文書間リンク設定情報一覧の取得条件を表す定数

定数
データ型
意味

RELATIONEND_HEAD
int型
文書間リンクで関連付けているリンク先オブジェクトの一覧を取得します。

RELATIONEND_TAIL
int型
文書間リンクで関連付けられているリンク元オブジェクトの一覧を取得します。

RELATIONEND_STATUS_EXIST
int型
関連付けの対象オブジェクトが存在しているリンク設定情報の一覧を取得します。

RELATIONEND_STATUS_NOT_EXIST
int型
すでに関連付けの対象オブジェクトが削除されていて，リンクだけが残っているリンク設定情報の一覧を取得します。
関連付けの対象オブジェクトが削除されているリンク設定情報はすべて取得されます。

RELATIONEND_STATUS_ALL
int型
すべてのリンク設定情報の一覧を取得する場合に指定します。
関連付けの対象オブジェクトが削除されているリンク設定情報はすべて取得されます。

7.1.14　Category：RENDSTATUS

レンディションステータスを表す定数です。

レンディションステータスを表す定数を表7-14に示します。

表7-14　レンディションステータスを表す定数

定数 | データ型 | 意味
RENDSTATUS_NO_SUBREND | int型 | 指定したサブレンディションに対応するマスタレンディションのコンテンツは登録済みですが，サブレンディションのコンテンツが未登録です。
RENDSTATUS_SUBREND_EXIST | int型 | 指定したサブレンディションに対応するマスタレンディションおよびサブレンディションのコンテンツが登録されています。
RENDSTATUS_MASTERREND_UPDATE | int型 | 指定したサブレンディションに対応するマスタレンディションが更新されていますが，サブレンディションが更新されていないため，マスタレンディションとサブレンディションの内容が不一致です。
RENDSTATUS_CONVERT_NOTREQUIRED | int型 | レンディション変換が不要な状態です。この状態の場合，DocumentBroker Rendering Optionによるレンディション変換の対象になりません。
RENDSTATUS_CONVERT_REQUIRED | int型 | レンディション変換が必要な状態です。この状態の場合，DocumentBroker Rendering Optionによるレンディション変換の対象になります。
RENDSTATUS_CONVERT_ERROR | int型 | DocumentBroker Rendering Optionによるレンディション変換時にエラーが発生した状態です。この状態になると，DocumentBroker Rendering Optionによるレンディション変換はできなくなります。
RENDSTATUS_MASTERD | int型 | 指定したレンディションがマスタレンディションの場合，設定されます。

7.1.15　Category：SUBJECTTYPE

サブジェクト種別を表す定数です。

サブジェクト種別を表す定数を表7-15に示します。

表7-15　サブジェクト種別を表す定数

定数 | データ型 | 意味
SUBJECTTYPE_USR | int型 | ユーザサブジェクトです。サブジェクトに設定した内容はユーザ識別子です。
SUBJECTTYPE_GRP | int型 | グループサブジェクトです。サブジェクトに設定した内容はグループ識別子です。
SUBJECTTYPE_SYS | int型 | システムサブジェクトです。サブジェクトに設定した内容は，システムサブジェクトを表す定数です。

7.1.16　Category：SYSSUBJECT

システムサブジェクトを表す定数です。

システムサブジェクトを表す定数を表7-16に示します。

表7-16　システムサブジェクトを表す定数

定数
データ型
意味

SYSSUBJECT_SELF
String型
対象オブジェクトの所有者を表すサブジェクトです。

対象オブジェクトがパブリックACLのACLの場合は，そのパブリックACLをバインドしている文書やフォルダを表すオブジェクトの所有者を示します。

対象オブジェクトが文書やフォルダを表すオブジェクトのローカルACLおよびセキュリティACLの場合は，そのオブジェクトの所有者を示します。

対象オブジェクトがパブリックACLのセキュリティACLの場合は，パブリックACLの所有者を示します。

SYSSUBJECT_EVERYONE
String型
すべてのユーザを表すサブジェクトです。

7.1.17　Category：XMLPARSE

XML文書の構文解析レベルを表す定数です。

XML文書の構文解析レベルを表す定数を表7-17に示します。

表7-17　XML文書の構文解析レベルを表す定数

定数 | データ型 | 意味
XMLPARSE_NO_EXTERNAL_ENTITIES | int型 | DTDの解析をしないで，外部エンティティは無視します。
XMLPARSE_WITH_EXTERNAL_ENTITIES | int型 | DTDを含めた構文解析をして外部エンティティを読み込みますが，検証は実行しません。
XMLPARSE_VALIDATE | int型 | DTDを使用して検証を実行します。

7.1.18　Category：Others

そのほかの内容を表す定数です。

そのほかの内容を表す定数を表7-18に示します。

表7-18　そのほかの内容を表す定数

定数 | データ型 | 意味
MAX_NUM | int型 | 検索結果の取得件数を最大とします。
INITIAL_KEY | int型 | キャッシュ検索を実行しません。
INDEXPATH_SAME | String型 | 全文検索インデクス作成用ファイルのパスをDbjUploadInfo#setIndexPathメソッドのfilePathプロパティに指定したファイルのパスとします。
CURRENT_VERSION | String型 | アクセス対象のバージョンをカレントバージョンとします。
DEFAULT_DOCSPCID | String型 | 文書空間識別子のデフォルト値（673d2be0-d1fd-11d0-ab59-08002be29e1d）です。

7.2　DbjTraceDefクラス

DbjTraceDefクラスは，Javaクラスライブラリのトレースクラスで使用する定数を定義したクラスです。

以降，DbjTraceDefクラスの定数定義内容について，カテゴリごとに説明します。

なお，DbjTraceDefクラスで定義されている定数のアクセス指定子は，すべて「public」です。

＜この節の構成＞

7.2.1　Category：TRACELEVEL

7.2.2　Category：TRACEOUTPUT

7.2.1　Category：TRACELEVEL

トレース出力時のトレースレベルを表す定数です。トレース出力時のトレースレベルを表す定数を表7-19に示します。

表7-19　トレース出力時のトレースレベルを表す定数

定数 | データ型 | 意味
ERROR | int型 | 障害監視レベル
MANAGE | int型 | 通常運用レベル
HINT | int型 | 障害調査レベル
DEBUG | int型 | デバッグレベル

7.2.2　Category：TRACEOUTPUT

トレース出力時のトレース出力先を表す定数です。トレース出力時のトレース出力先を表す定数を表7-20に示します。

表7-20　トレース出力時のトレース出力先を表す定数

定数 | データ型 | 意味
PROMPT | int型 | コマンドプロンプト（標準出力・標準エラー出力）に出力します。
TRACE | int型 | アプリケーショントレースファイルに出力します。
ERRORLOG | int型 | アプリケーションエラーログファイルに出力します。
SYSTEM | int型 | イベントログファイルまたはsyslogファイルに出力します。

8.　ライブラリ情報取得クラス詳細

この章では，ライブラリ情報取得クラスのDbjLibInfoクラス，およびメソッドについて説明します。

＜この章の構成＞

8.1　DbjLibInfoクラス

8.1　DbjLibInfoクラス

DbjLibInfoクラスは，DocumentBroker Development KitおよびDocumentBroker Runtimeのバージョン情報を扱うクラスです。このクラスはインスタンスを生成できません（コンストラクタは，private属性です）。

以降，DbjLibInfoクラスのメソッドについて説明します。

＜この節の構成＞

8.1.1　getVersion（バージョンの取得）

8.1.1　getVersion（バージョンの取得）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

DocumentBroker Development KitおよびDocumentBroker Runtimeのバージョン番号およびリビジョン番号を取得します。バージョン番号およびリビジョン番号は，次に示す計算式によって値を求めた結果の整数値で取得します。なお，バージョン番号およびリビジョン番号がXX-YYの場合，XXをバージョン番号，YYをリビジョン番号とします。ただし，リビジョン番号は２けたまでです。

計算式

(A×100)+B

（凡例）

A：バージョン番号

B：リビジョン番号

例えば，バージョン番号－リビジョン番号が02-10の場合，バージョン番号は2，リビジョン番号は10になります。したがって，このメソッドの実行によって210が返却されます。

(2)　形式

static int getVersion()

(3)　引数

なし

(4)　戻り値

バージョン番号およびリビジョン番号

(5)　例外

なし

9.　トレースクラス詳細

この章では，トレースクラスのクラスとそのメソッドについて説明します。

＜この章の構成＞

9.1　DbjTraceクラス

9.1　DbjTraceクラス

DbjTraceクラスは，トレース情報を扱うクラスです。以降，DbjTraceクラスのメソッドについて説明します。

＜この節の構成＞

9.1.1　arg（パラメタ情報の出力）

9.1.2　call（外部APIの呼び出し情報の出力）

9.1.3　DbjTrace（コンストラクタ）

9.1.4　enter（メソッドの入り口情報の出力）

9.1.5　error（エラー情報の出力）

9.1.6　exit（メソッドの出口情報の出力）

9.1.7　hint（下位のメソッドのエラー情報の出力）

9.1.8　init（トレースクラスの初期化）

9.1.9　msg（メッセージの出力）

9.1.10　returned（外部APIからのリターン情報の出力）

9.1.1　arg（パラメタ情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メソッドの入り口での入力パラメタ，または外部APIに渡すパラメタ情報を出力します。引数で指定したパラメタ名およびパラメタに設定した値を出力します。このメソッドは，メソッドの入り口または外部APIの実行前に実行してください。

(2)　形式

int型のパラメタ情報を出力する場合は，形式1～形式3の形式で指定してください。String型のパラメタ情報を出力する場合は，形式4～形式6の形式で指定してください。

(a)　形式1

void arg(
   String        name,
   int           value
   DbjTraceDef   level,
   int           output
)

(b)　形式2

void arg(
   String        name,
   int           value
   DbjTraceDef   level
)

形式2の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(c)　形式3

void arg(
   String        name,
   int           value
)

形式3の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.DEBUGになります。

(d)　形式4

void arg(
   String        name,
   String        value
   DbjTraceDef   level,
   int           output
)

(e)　形式5

void arg(
   String        name,
   String        value
   DbjTraceDef   level
)

形式5の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(f)　形式6

void arg(
   String        name,
   String        value
)

形式6の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.DEBUGになります。

(3)　引数

name（入力）

メソッド入力のパラメタ名，または外部APIに渡すパラメタ名を指定します。

value（入力）

パラメタに設定した値を指定します。

level（入力）

トレースレベルを指定します。次に示すトレースレベルのうち，どれかを指定してください。

DbjTraceDef.ERROR
障害監視レベル

DbjTraceDef.MANAGE
通常運用レベル

DbjTraceDef.HINT
障害調査レベル

DbjTraceDef.DEBUG
デバッグレベル

output（入力）

トレース情報の出力先を指定します。次に示す出力先を指定できます。

DbjTraceDef.PROMPT
コマンドプロンプト（標準出力・標準エラー出力）に出力します。

DbjTraceDef.TRACE
アプリケーショントレースファイルに出力します。

DbjTraceDef.ERRORLOG
アプリケーションエラーログファイルに出力します。

前記以外の出力先を指定した場合，トレース情報は出力されません（実行したメソッドは正常終了します）。

複数の出力先を指定する場合は，OR演算子を用いて定数を連結してください。例えば，DbjTraceDef.TRACEとDbjTraceDef.ERRRORLOGに同時出力する場合は，DbjTraceDef.TRACE | DbjTraceDef.ERRORLOGと指定してください。

(4)　戻り値

なし

(5)　例外

なし

9.1.2　call（外部APIの呼び出し情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

外部APIの呼び出し時の情報を出力します。引数で指定した呼び出し元のクラス名およびメソッド名を出力します。このメソッドは，外部APIの呼び出し時に実行してください。

(2)　形式

クラス名およびメソッド名を出力する場合は，形式1～形式3の形式で指定してください。メソッド名だけを出力する場合は，形式4～形式6の形式で指定してください。

(a)　形式１

void call(
   String        className,
   String        methodName,
   DbjTraceDef   level,
   int           output
)

(b)　形式2

void call(
   String        className,
   String        methodName,
   DbjTraceDef   level
)

形式2の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(c)　形式3

void call(
   String        className,
   String        methodName
)

形式3の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.DEBUGになります。

(d)　形式4

void call(
   String        methodName,
   DbjTraceDef   level,
   int           output
)

(e)　形式5

void call(
   String        methodName,
   DbjTraceDef   level
)

形式5の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(f)　形式6

void call(
   String        methodName
)

形式6の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.DEBUGになります。

(3)　引数

className（入力）

呼び出しクラスの名称を256バイト以内で指定します。256バイトを超えた名称を指定した場合は，256バイトまでの文字列が設定されます。

methodName（入力）

呼び出しメソッドの名称を256バイト以内で指定します。256バイトを超えた名称を指定した場合は，256バイトまでの文字列が設定されます。

level（入力）

トレースレベルを指定します。次に示すトレースレベルのうち，どれかを指定してください。

DbjTraceDef.ERROR
障害監視レベル

DbjTraceDef.MANAGE
通常運用レベル

DbjTraceDef.HINT
障害調査レベル

DbjTraceDef.DEBUG
デバッグレベル

output（入力）

トレース情報の出力先を指定します。次に示す出力先を指定できます。

DbjTraceDef.TRACE
アプリケーショントレースファイルに出力します。

前記以外の出力先を指定した場合，トレース情報は出力されません（実行したメソッドは正常終了します）。

(4)　戻り値

なし

(5)　例外

なし

9.1.3　DbjTrace（コンストラクタ）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

DbjTraceオブジェクトを作成します。

(2)　形式

DbjTrace(
   String     upName,
   String     className,
   String     methodName
)

(3)　引数

upName（入力）

アプリケーション名を指定します。

ここで指定したアプリケーション名をinitメソッドの引数upNameに指定してください。異なるアプリケーション名を指定した場合，トレース情報は出力されません。また，アプリケーション名にnullを指定した場合もトレース情報は出力されません。

className（入力）

クラス名を256バイト以内で指定します。256バイトを超えた名称を指定した場合は，256バイトまでの文字列が設定されます。

nullを指定した場合，クラス名は設定されません。この場合，メソッド名だけが出力されます。

methodName（入力）

メソッド名を256バイト以内で指定します。256バイトを超えた名称を指定した場合は，256バイトまでの文字列が設定されます。

nullを指定した場合，enterまたはexitメソッドを実行しても，トレース情報は出力されません。

(4)　戻り値

なし

(5)　例外

なし

9.1.4　enter（メソッドの入り口情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メソッドの入り口情報を出力します。DbjTraceメソッドで指定したクラス名およびメソッド名を出力します。このメソッドは，メソッドの入り口で実行してください。

(2)　形式

(a)　形式1

void enter(
   DbjTraceDef     level,
   int             output
)

(b)　形式2

void enter(
   DbjTraceDef     level
)

形式2の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(c)　形式3

void enter()

形式3の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.DEBUGになります。

(3)　引数

level（入力）

トレースレベルを指定します。次に示すトレースレベルのうち，どれかを指定してください。

DbjTraceDef.ERROR
障害監視レベル

DbjTraceDef.MANAGE
通常運用レベル

DbjTraceDef.HINT
障害調査レベル

DbjTraceDef.DEBUG
デバッグレベル

output（入力）

トレース情報の出力先を指定します。次に示す出力先を指定できます。

DbjTraceDef.PROMPT
コマンドプロンプト（標準出力・標準エラー出力）に出力します。

DbjTraceDef.TRACE
アプリケーショントレースファイルに出力します。

前記以外の出力先を指定した場合，トレース情報は出力されません（実行したメソッドは正常終了します）。

複数の出力先を指定する場合は，OR演算子を用いて定数を連結してください。例えば，DbjTraceDef.PROMPTとDbjTraceDef.TRACEに同時出力する場合は，DbjTraceDef.PROMPT | DbjTraceDef.TRACEと指定してください。

(4)　戻り値

なし

(5)　例外

なし

9.1.5　error（エラー情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

ユーザアプリケーションプログラムにエラーが発生したときのエラー情報を出力します。引数で指定したメッセージまたは例外クラスを出力します。このメソッドは，ユーザアプリケーションプログラムのエラー発生時に実行してください。

(2)　形式

エラー情報をメッセージにして出力する場合は，形式1～形式3の形式で指定してください。通常の例外の情報を出力する場合は，形式4～形式6の形式で指定してください。Java クラスライブラリの例外の情報を出力する場合は，形式7～形式9の形式で指定してください。

(a)　形式1

void error(
   String        message,
   DbjTraceDef   level,
   int           output
)

(b)　形式2

void error(
   String        message,
   DbjTraceDef   level
)

形式2の場合，トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。

(c)　形式3

void error(
   String        message
)

形式3の場合，トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。また，トレースレベルはDbjTraceDef.ERRORになります。

(d)　形式4

void error(
   Exception     ex,
   DbjTraceDef   level,
   int           output
)

(e)　形式5

void error(
   Exception     ex,
   DbjTraceDef   level
)

形式5の場合，トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。

(f)　形式6

void error(
   Exception     ex
)

形式6の場合，トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。また，トレースレベルはDbjTraceDef.ERRORになります。

(g)　形式7

void error(
   DbjException   ex,
   DbjTraceDef    level,
   int            output
)

(h)　形式8

void error(
   DbjException   ex,
   DbjTraceDef    level
)

形式8の場合，トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。

(i)　形式9

void error(
   DbjException   ex
)

形式9の場合，トレース情報の出力先はアプリケーショントレースファイルおよびアプリケーションエラーログファイルになります。また，トレースレベルはDbjTraceDef.ERRORになります。

(3)　引数

message（入力）

出力するメッセージを指定します。

ex（入力）

発生した例外クラスを指定します。

Exceptionクラスおよびそのサブクラスを指定した場合は，ex.getMessage()およびex.printStackTrace()の内容が出力されます。

level（入力）

トレースレベルを指定します。次に示すトレースレベルのうち，どれかを指定してください。

DbjTraceDef.ERROR
障害監視レベル

DbjTraceDef.MANAGE
通常運用レベル

DbjTraceDef.HINT
障害調査レベル

DbjTraceDef.DEBUG
デバッグレベル

output（入力）

トレース情報の出力先を指定します。次に示す出力先を指定できます。

DbjTraceDef.PROMPT
コマンドプロンプト（標準出力・標準エラー出力）に出力します。

DbjTraceDef.TRACE
アプリケーショントレースファイルに出力します。

DbjTraceDef.ERRORLOG
アプリケーションエラーログファイルに出力します。

前記以外の出力先を指定した場合，トレース情報は出力されません（実行したメソッドは正常終了します）。

複数の出力先を指定する場合は，OR演算子を用いて定数を連結してください。例えば，DbjTraceDef.TRACEとDbjTraceDef.ERRRORLOGに同時出力する場合は，DbjTraceDef.TRACE | DbjTraceDef.ERRORLOGと指定してください。

(4)　戻り値

なし

(5)　例外

なし

9.1.6　exit（メソッドの出口情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メソッドの出口情報を出力します。DbjTraceメソッドで指定したクラス名およびメソッド名を出力します。このメソッドは，メソッドの出口で実行してください。

クラス名およびメソッド名については，DbjTraceメソッドで指定した値が設定されます。トレースレベルおよび出力先については，enterメソッドで指定した値が設定されます。したがって，enterメソッドを実行する前にexitメソッドを実行した場合，トレース情報は出力されません。

(2)　形式

void exit()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

9.1.7　hint（下位のメソッドのエラー情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

下位のメソッドでエラーが発生したときのエラー情報を出力します。引数で指定したメッセージを出力します。このメソッドは，下位のメソッドのエラー発生時に実行してください。

(2)　形式

(a)　形式1

void hint(
   String        message,
   DbjTraceDef   level,
   int           output
)

(b)　形式2

void hint(
   String        message,
   DbjTraceDef   level
)

形式2の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(c)　形式3

void hint(
   String        message
)

形式3の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.HINTになります。

(3)　引数

message（入力）

出力するメッセージを指定します。

level（入力）

トレースレベルを指定します。次に示すトレースレベルのうち，どれかを指定してください。

DbjTraceDef.ERROR
障害監視レベル

DbjTraceDef.MANAGE
通常運用レベル

DbjTraceDef.HINT
障害調査レベル

DbjTraceDef.DEBUG
デバッグレベル

output（入力）

トレース情報の出力先を指定します。次に示す出力先を指定できます。

DbjTraceDef.TRACE
アプリケーショントレースファイルに出力します。

前記以外の出力先を指定した場合，トレース情報は出力されません（実行したメソッドは正常終了します）。

(4)　戻り値

なし

(5)　例外

なし

9.1.8　init（トレースクラスの初期化）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

トレースクラスを初期化します。

このメソッドで指定する引数tracePrefixを基に，アプリケーショントレースファイル名およびアプリケーションエラーログファイル名が次のように決まります。

●アプリケーショントレースファイルの場合

アプリケーショントレースファイル名の例を次に示します。

●アプリケーションエラーログファイルの場合

アプリケーションエラーログファイル名の例を次に示します。

注意

DbjTraceクラスを使用してトレース情報を出力するには，最初にinitメソッドを実行してトレースクラスを初期化してください。initメソッドの実行前や，initメソッドで例外が送出された場合に，init以外のメソッドを実行すると，そのメソッドは処理を行わないで正常終了します。

initメソッドが正常終了したあとに，同じupNameおよびtracePrefixを指定したinitメソッドを実行できません。同じupNameおよびtracePrefixを指定したinitメソッドを実行した場合，処理を行わないで正常終了します。

(2)　形式

void init(
   String     upName
   String     tracePrefix
)

(3)　引数

upName（入力）

アプリケーション名を16バイト以内で指定します。16バイトを超えた名称を指定した場合は，16バイトまでの文字列が設定されます。nullを指定した場合は，「DbjAP」が設定されます。

tracePrefix（入力）

アプリケーショントレースファイル名およびアプリケーションエラーログファイル名のプリフィクス（先頭部分）を128バイト以内で指定します。128バイトを超えた名称を指定した場合は，128バイトまでの文字列が設定されます。nullを指定した場合は，「DbjAPTrace」が設定されます。

(4)　戻り値

なし

(5)　例外

IllegalArgumentException

指定した引数に誤りがある場合，この例外が送出されます。例えば，次に示す場合にこの例外が送出されます。

正常終了したinitメソッドと同じupNameまたはtracePrefixを指定し，再度initメソッドを実行した場合

IOException

ファイル操作に失敗した場合，この例外が送出されます。例えば，次に示す場合にこの例外が送出されます。

アプリケーショントレースファイルまたはアプリケーションエラーログファイルの格納先ディレクトリがない場合

アプリケーショントレースファイルまたはアプリケーションエラーログファイルを作成する権限がない場合

アプリケーショントレースファイルまたはアプリケーションエラーログファイルのパス長（格納先ディレクトリとファイルのパス長の合計）が最大パス長を超えている場合

9.1.9　msg（メッセージの出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

メッセージを出力します。引数で指定したメッセージIDおよびメッセージを出力します。このメソッドは，メッセージの出力が必要なときに実行してください。

●出力先にイベントログファイルを指定した場合（Windows限定）

引数messageIDの終端文字の指定によって，イベントログの種類が決まります。引数messageIDの終端文字の指定とイベントログの種類の対応を表9-1に示します。

表9-1　引数messageIDの終端文字の指定とイベントログの種類の対応

引数messageIDの終端文字の指定 | イベントログの種類
-E | エラー
-W | 警告
-I | 情報
上記以外

(2)　形式

メッセージIDおよびメッセージを出力する場合は，形式1～形式3の形式で指定してください。メッセージだけを出力する場合は，形式4～形式6の形式で指定してください。

(a)　形式1

void msg(
   String        messageID,
   String        message,
   DbjTraceDef   level,
   int           output
)

(b)　形式2

void msg(
   String        messageID,
   String        message,
   DbjTraceDef   level
)

形式2の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(c)　形式3

void msg(
   String        messageID,
   String        message
)

形式3の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.ERRORになります。

(d)　形式4

void msg(
   String        message,
   DbjTraceDef   level,
   int           output
)

(e)　形式5

void msg(
   String        message,
   DbjTraceDef   level
)

形式5の場合，トレース情報の出力先はアプリケーショントレースファイルになります。

(f)　形式6

void msg(
   String        message
)

形式6の場合，トレース情報の出力先はアプリケーショントレースファイルになります。また，トレースレベルはDbjTraceDef.ERRORになります。

(3)　引数

messageID（入力）

出力するメッセージIDを11バイト以内で指定します。11バイトを超えた場合は，11バイトまでの文字列が設定されます。nullを指定した場合，メッセージIDは設定されません。

message（入力）

出力するメッセージを指定します。

level（入力）

トレースレベルを指定します。次に示すトレースレベルのうち，どれかを指定してください。

DbjTraceDef.ERROR
障害監視レベル

DbjTraceDef.MANAGE
通常運用レベル

DbjTraceDef.HINT
障害調査レベル

DbjTraceDef.DEBUG
デバッグレベル

output（入力）

トレース情報の出力先を指定します。次に示す出力先を指定できます。

DbjTraceDef.PROMPT
コマンドプロンプト（標準出力・標準エラー出力）に出力します。

DbjTraceDef.TRACE
アプリケーショントレースファイルに出力します。

DbjTraceDef.ERRORLOG
アプリケーションエラーログファイルに出力します。

DbjTraceDef.SYSTEM
イベントログファイルまたはsyslogファイルに出力します。

前記以外の出力先を指定した場合，トレース情報は出力されません（実行したメソッドは正常終了します）。

複数の出力先を指定する場合は，OR演算子を用いて定数を連結してください。例えば，DbjTraceDef.TRACEとDbjTraceDef.ERRRORLOGに同時出力する場合は，DbjTraceDef.TRACE | DbjTraceDef.ERRORLOGと指定してください。

(4)　戻り値

なし

(5)　例外

なし

9.1.10　returned（外部APIからのリターン情報の出力）

＜この項の構成＞

(1)　機能

(2)　形式

(3)　引数

(4)　戻り値

(5)　例外

(1)　機能

外部APIから制御が戻ってきたときの情報を出力します。callメソッドの引数で指定したクラス名およびメソッド名を出力します。このメソッドは，外部APIから制御が戻ってきたときに実行してください。

クラス名，メソッド名，トレースレベルおよび出力先については，callメソッドで指定した値が設定されます。したがって，callメソッドを実行する前にreturnedメソッドを実行した場合，トレース情報は出力されません。

(2)　形式

void returned()

(3)　引数

なし

(4)　戻り値

なし

(5)　例外

なし

10.　メッセージの一覧

この章では，Java クラスライブラリが出力するメッセージについて説明します。

＜この章の構成＞

10.1　メッセージの形式と見方

10.2　メッセージの詳細

10.1　メッセージの形式と見方

この節では，Java クラスライブラリが出力するメッセージの形式と見方について説明します。

＜この節の構成＞

(1)　メッセージの形式

(2)　メッセージテキスト中の可変値について

(3)　メッセージの見方

(4)　注意

(1)　メッセージの形式

Java クラスライブラリで出力されるメッセージは，クライアント共有トレースファイルに出力されます。詳細はマニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「8.2　メッセージ情報」を参照してください。

メッセージの形式を次に示します。

KMBJnnnnn-T：メッセージテキスト

KMBJ

「KMBJ」はJava クラスライブラリのメッセージを示します。

nnnnn

メッセージの通し番号です。

T

タイプコードです。次のように対応しています。

Ｉ（Information）

Java クラスライブラリの動作を通知するメッセージです。メッセージの発行後も処理を続行します。

Ｗ（Warning）

警告レベルのトラブルが発生したことを通知するメッセージです。メッセージの発行後も処理を続行します。

Ｅ（Error）

エラーレベルのトラブルが発生したことを通知するメッセージです。このメッセージが発行されたときは，メソッドの実行を中断します。ただし，致命的なエラーでなければ，処理を再開できます。

(2)　メッセージテキスト中の可変値について

メッセージテキスト中の%s，%n（nは挿入句の順番）はそれぞれテキスト，数値型の可変値です。

(3)　メッセージの見方

このマニュアルでは，メッセージを次に示す形式で説明しています。

KMBJnnnnn-T

日本語のメッセージテキスト
英文のメッセージテキスト

要因

メッセージが通知された要因

対処

メッセージに対するユーザの対処方法

(4)　注意

(a)　メッセージテキストについて

実際に出力されるメッセージテキストは，日本語または英文のどちらか一方です。デフォルトでは，日本語になっています。

メッセージテキストを，日本語から英文または英文から日本語に変更する方法については，マニュアル「DocumentBroker Version 3　クラスライブラリ　Java　解説」の「7.4.2　環境変数の設定」を参照してください。

(b)　対処に「システム管理者に連絡してください」とある場合について

「システム管理者に連絡してください」とは，システム管理者が対処するか，システム管理者が弊社社員または弊社担当営業に連絡することを示します。

エラーコードなどは，システム管理者，弊社社員または弊社担当営業が使う情報です。

システム管理者，弊社社員または弊社担当営業に連絡される際には，極力，次に示す情報もお伝えくださいます様お願いします。

いつエラーが発生したのか

エラー発生の直前にどのような操作をしたのか

エラー発生時に画面などがどのように動作したのか

エラー発生時に出力されたメッセージの内容

できるだけ正確な内容でお伝えください。特にメッセージ番号と可変値は必要な情報です。

DocumentBrokerサーバを運用中に発生したエラーメッセージの詳細については，マニュアル「DocumentBroker Version 3　メッセージ」を参照してください。

10.2　メッセージの詳細

この節では，Java クラスライブラリでエラー発生時に出力される各エラーメッセージの詳細について説明します。

＜この節の構成＞

KMBJ00001-E

KMBJ00002-E

KMBJ00003-E

KMBJ00004-E

KMBJ00005-E

KMBJ00006-E

KMBJ00007-E

KMBJ00008-E

KMBJ00009-E

KMBJ00010-E

KMBJ00011-E

KMBJ00012-E

KMBJ00013-E

KMBJ00014-E

KMBJ00015-E

KMBJ00016-E

KMBJ00017-E

KMBJ00018-E

KMBJ00019-E

KMBJ00020-E

KMBJ00021-E

KMBJ00022-E

KMBJ00023-E

KMBJ00024-E

KMBJ00025-E

KMBJ00026-E

KMBJ00027-E

KMBJ00028-E

KMBJ00029-E

KMBJ00030-E

KMBJ00031-E

KMBJ00032-E

KMBJ00033-E

KMBJ00034-E

KMBJ00035-E

KMBJ00036-E

KMBJ00037-E

KMBJ00038-E

KMBJ00039-E

KMBJ00040-E

KMBJ00041-E

KMBJ00042-E

KMBJ00043-E

KMBJ00044-E

KMBJ00045-E

KMBJ00046-E

KMBJ00047-E

KMBJ00048-E

KMBJ00049-E

KMBJ00050-E

KMBJ00051-E

KMBJ00052-E

KMBJ00053-E

KMBJ00054-E

KMBJ00055-E

KMBJ00056-E

KMBJ00057-E

KMBJ00058-E

KMBJ00059-E

KMBJ00060-E

KMBJ00061-E

KMBJ00062-E

KMBJ00063-E

KMBJ00064-E

KMBJ00065-E

KMBJ00066-E

KMBJ00067-E

KMBJ00068-E

KMBJ00069-E

KMBJ00070-E

KMBJ00071-W

KMBJ00072-E

KMBJ00073-E

KMBJ00074-E

KMBJ00075-E

KMBJ00076-E

KMBJ00077-E

KMBJ00078-E

KMBJ00079-E

KMBJ00080-E

KMBJ00081-E

KMBJ00082-E

KMBJ00083-E

KMBJ00084-E

KMBJ00085-E

KMBJ00086-E

KMBJ00087-E

KMBJ00088-E

KMBJ00089-W

KMBJ00090-W

KMBJ00091-W

KMBJ00092-E

KMBJ00093-E

KMBJ00094-E

KMBJ00095-E

KMBJ00096-E

KMBJ00097-E

KMBJ00098-E

KMBJ00099-E

KMBJ00100-E

KMBJ00101-E

KMBJ00102-E

KMBJ00103-E

KMBJ00104-E

KMBJ00105-E

KMBJ00106-E

KMBJ00107-E

KMBJ00108-E

KMBJ00109-E

KMBJ00110-E

KMBJ00111-E

KMBJ00112-E

KMBJ00113-E

KMBJ00114-E

KMBJ00115-E

KMBJ00116-W

KMBJ00117-E

KMBJ00118-W

KMBJ00119-E

KMBJ00120-E

KMBJ00121-E

KMBJ00122-E

KMBJ00123-E

KMBJ00124-E

KMBJ00125-E

KMBJ00126-E

KMBJ00127-E

KMBJ00128-E

KMBJ00129-E

KMBJ00132-E

KMBJ00133-E

KMBJ00134-E

KMBJ00001-E

指定された操作は，指定されたオブジェクトに対しては，サポートされていません。操作とオブジェクトの型を見直してください。
The specified operation is not supported by the specified object, Try out the operation with the appropriate object type.

要因

指定したオブジェクトに対する操作はサポートされていません。

対処

オブジェクトの型を見直して，再実行してください。

KMBJ00002-E

内部エラーが発生しました。システム管理者に連絡してください。
An Internal Error has occurred, contact the System Administrator.

要因

内部エラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00003-E

メモリが不足しているため，指定された操作を実行できません。システム管理者に連絡してください。
The specified operation cannot be carried out since the system is running out of memory, Contact System Administrator.

要因

メモリが不足しているため，指定された操作を実行できません。

対処

メモリを増設するか，メモリを大量に消費しているアプリケーションを終了して，利用できるメモリを増やしてから，処理を再実行してください。

KMBJ00004-E

ログインされていません。
The User has not legged in, login and try again.

要因

ログインされていません。

対処

ログインしてから，操作を実行してください。

KMBJ00005-E

セッションが切断されています。接続してから，再実行してください。
The Session got disconnected, try again after reconnecting.

要因

セッションが切断されています。

対処

再接続して，再実行してください。

KMBJ00006-E

データベースでタイムアウトが発生しました。SQLCODE: %4, SQLSTATE: %5 再実行してください。
A Data Base time out has occurred, SQL CODE: %4, SQL STATE: %5. Perform the operation again.

要因

データベースでタイムアウトが発生しました。SQLCODE: %4, SQLSTATE: %5

対処

再実行してください。

KMBJ00007-E

データベースでデッドロックが発生しました。SQLCODE: %4, SQLSTATE: %5 システム管理者に連絡してください。
A dead lock has occurred SQLCODE: %4, SQLSTATE; %5. Contact the System Administrator

要因

データベースでデッドロックが発生しました。SQLCODE: %4, SQLSTATE: %5

対処

システム管理者に連絡してください。

KMBJ00008-E

セッションが接続されていません。接続してから，実行してください。
The Session is not connected. Try after Connecting.

要因

セッションが接続されていません。

対処

接続してから，再実行してください。

KMBJ00009-E

CORBAエラーが発生しました。CORBA%4 システム管理者に連絡してください。
A CORBA Error has been occurred, CORBA%4. Contact System administrator.

要因

CORBAエラーが発生しました。

対処

ユーザアプリケーションプログラムがTPBrokerに接続できません。ユーザアプリケーションプログラムを終了させてください。

KMBJ00010-E

指定されたオブジェクトは不正です。適切なオブジェクトを指定して実行してください。
The specified object is invalid, Try out the operation with the appropriate object type.

要因

指定されたオブジェクトは，サポートされていない型のオブジェクトです。

対処

適切な型のオブジェクトを指定して，再実行してください。

KMBJ00011-E

サーバに接続できません。システム管理者に連絡してください。
Cannot connect to the Server. Contact System Administrator.

要因

サーバに接続しているユーザ数が，上限を超えています。

対処

しばらくたってから接続するか，文書空間へのユーザ接続数の上限値を変更してください。

KMBJ00012-E

指定された文書空間識別子は，存在しません。有効な文書空間識別子を指定してください。
Specified Document space Id does not exist. Specify a valid value.

要因

ログイン時に指定された文書空間識別子は，存在しません。

対処

有効な文書空間識別子を指定してください。

KMBJ00013-E

文書空間識別子が指定されていません。文書空間識別子を指定してください。
Specified Document space Id is null. Specify a valid value.

要因

ログイン時に文書空間識別子が指定されていません。

対処

有効な文書空間識別子を指定してください。

KMBJ00014-E

ユーザ名が指定されていません。ユーザ名を指定してください。
Specified User Name is null. Specify a valid value.

要因

ログイン時にユーザ名が指定されていません。

対処

有効なユーザ名を指定してください。

KMBJ00015-E

パスワードが指定されていません。パスワードを指定してください。
Specified Password is null. Specify a valid value.

要因

ログイン時にパスワードが指定されていません。

対処

正しいパスワードを指定してください。

KMBJ00016-E

ユーザ：%4のログインが失敗しました。ログインの引数が不正です。正しい値を指定してください。
Login failed for the user: %4. Invalid Login parameters. Enter correct values.

要因

指定ユーザは認証されませんでした。

対処

有効なユーザ名とパスワードを指定してください。

KMBJ00017-E

アクセス制御機能が未サポートです。システム管理者に連絡してください。
Access control function is not supported. Contact System Administrator.

要因

アクセス制御機能がサポートされていません。

対処

この操作は，実行できません。

KMBJ00018-E

メソッドの実行順序が不正です。正しい順序でメソッドを使用してください。
The sequence in which one method follows another is invalid. Use methods in valid sequence.

要因

メソッドの実行順序が不正です。

トランザクションが開始されていない状態でトランザクションを有効または無効にしようとしました。

トランザクション処理中に，ほかのトランザクションを開始しようとしました。

対処

この操作は，実行できません。

KMBJ00019-E

指定されたリレーションのタイプが不正です。正しいリレーションのタイプを指定してください。
The Relation Type specified is invalid. Specify proper Relation type.

要因

DbjObj#getRelListメソッドで指定されたリレーションタイプが不正です。

対処

正しいリレーションタイプを指定してください。

KMBJ00020-E

指定されたリレーションステータスが不正です。正しいリレーションステータスを指定してください。
The Relation status specified is invalid. Specify proper Relation state.

要因

DbjObj#getRelListメソッドで指定されたリレーションステータスが不正です。

対処

正しいリレーションステータスを指定してください。

KMBJ00021-E

指定された操作を実行する権限がありません。システム管理者に連絡してください。
No access right to carry out the specified operation. Contact System Administrator.

要因

指定された操作を実行する権限がありません。

対処

アクセス制御情報のパーミッションを変更して，再実行してください。

KMBJ00022-E

この操作で使用するオブジェクトは，既に削除されています。
The Object used in this operation is already deleted. Specify a valid object.

要因

この操作で使用するオブジェクトは，すでに削除されています。

対処

存在するオブジェクトを指定して，再実行してください。

KMBJ00023-E

ロックの種類が不正です。正しい種類のロックを指定してください。
Invalid Lock Type. Specify proper lock type.

要因

指定されたロックの種類が不正です。

対処

正しい種類のロックを指定してください。

KMBJ00024-E

プロパティ識別子が不正です。正しいプロパティ識別子を指定してください。
Invalid Property Identifier. Specify proper Identifier value.

要因

不正なプロパティ識別子が含まれています。

対処

プロパティ識別子を見直して，再実行してください。

KMBJ00025-E

要求された要素が見付かりません。有効なオブジェクトを指定してください。
The Requested Elements not found. Specify valid objects.

要因

要求された要素が見つかりません。

対処

存在するオブジェクトを指定してください。

KMBJ00026-E

セッションの状態が不正です。システム管理者に連絡してください。
Invalid session status. Contact System Administrator.

要因

セッションの状態が不正です。

対処

一つのセッションに対して１度に一つの処理要求しか出さないように見直してください。

KMBJ00027-E

OIIDが設定されていません。正しいOIIDを設定してください。
OIID is not Set. Set proper value for OIID.

要因

OIIDが設定されていません。

対処

正しいOIIDを設定してください。

KMBJ00028-E

予期しないエラーが発生しました。システム管理者に連絡してください。
An Unexpected Error has occurred. Contact the System Administrator.

要因

予期しないエラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00029-E

引数%4が不正です。有効な引数を指定してください。
Argument No %4 is not a valid one. Specify a valid argument.

要因

引数%4が不正です。

対処

有効な引数を指定してください。

KMBJ00030-E

データベースでエラーが発生しました。システム管理者に連絡してください。SQLCODE: %4, SQLSTATE: %5.
Data Base Error has occurred. Contact the System Administrator. SQLCODE: %4, SQLSTATE: %5.

要因

データベースでエラーが発生したため操作を実行できません。SQLCODE: %4, SQLSTATE: %5

対処

システム管理者に連絡してください。

KMBJ00031-E

クラス識別子が不正です。有効なクラス識別子を指定してください。
Invalid Class Id. Specify valid value for Class Id.

要因

指定されたクラス識別子が不正です。

対処

有効なクラス識別子を指定してください。

KMBJ00032-E

OIIDが不正です。有効なOIIDを指定してください。
Invalid OIID. Specify valid value for OIID.

要因

指定されたOIIDが不正です。

対処

有効なOIIDを指定してください。

KMBJ00033-E

不正なパラメタでサーバを操作しました。
Invoked server operation with invalid parameter.

要因

不正なパラメタでサーバを操作しました。

対処

内部エラーが発生しました。システム管理者に連絡してください。

KMBJ00034-E

このセッションでは，この操作はサポートされていません。システム管理者に連絡してください。
This operation is not supported in this session. Contact System Administrator.

要因

このセッションでは，この操作はサポートされていません。

対処

指定された操作は，実行できません。

KMBJ00035-E

指定された操作は，アクセス権がないため，実行できません。システム管理者に連絡してください。
No access to the specified operation. Contact System Administrator.

要因

指定された操作に対するアクセス権がありません。

対処

アクセス権を変更して，再実行してください。

KMBJ00036-E

指定されたパブリックACLは，存在しません。有効な値を指定してください。
Specified public ACL does not exist. Specify a valid value.

要因

指定されたパブリックACLは，存在しません。

対処

存在するパブリックACLを指定してください。

KMBJ00037-E

バインドされていないパブリックACLです。バインドされているパブリックACLを指定してください。
Unbound public ACL. Specify bound public ACL.

要因

指定されたパブリックACLは，指定されたオブジェクトにバインドされていません。

対処

バインドされているパブリックACLを指定して，再実行してください。

KMBJ00038-E

保持できるレンディション数の上限に達しました。システム管理者に連絡してください。
Reached the maximum value of rendition count. Contact System Administrator.

要因

保持できるレンディション数の上限に達しました。

対処

不要なレンディションを削除して，新しいレンディションを追加してください。

KMBJ00039-E

マスタレンディションが設定されていません。設定してから操作を実行してください。
Master Rendition is not Set. Set the value and carry out the operation.

要因

マスタレンディションの値が設定されていません。

対処

操作を実行する前に，マスタレンディションの値を設定してください。

KMBJ00040-E

指定されたレンディションは既に存在しています。
Specified Rendition type already exists.

要因

指定されたレンディションはすでに存在しています。

対処

存在しないレンディションタイプのレンディションを指定してください。

KMBJ00041-E

この操作は，マスタレンディションに対して実行できません。ほかの値を指定してください。
Operation cannot be carried out on master rendition. Specify another value.

要因

この操作は，マスタレンディションに対して実行できません。

対処

サブレンディションを指定して，再実行してください。

KMBJ00042-E

コンテンツを更新できません。システム管理者に連絡してください。
Contents not updated. Contact System Administrator.

要因

コンテンツが更新されていません。

対処

コンテンツを更新して，再実行してください。

KMBJ00043-E

存在しないレンディションタイプです。有効な値を指定してください。
Non existing Rendition type. Specify a valid value.

要因

指定されたレンディションタイプは，存在しません。

対処

存在するレンディションを指定して，再実行してください。

KMBJ00044-E

バージョン識別子が予約されていません。
Version identifier is not reserved.

要因

バージョン識別子が予約されていないため，指定された操作は実行できません。

対処

チェックイン時に割り当てられた正しいバージョン識別子を設定して，再実行してください。

KMBJ00045-E

アクセス権がありません。システム管理者に連絡してください。
No Access permission. Contact System Administrator.

要因

指定された操作を実行するためのパーミッションがありません。

対処

パーミッションを見直して，再実行してください。

KMBJ00046-E

アクセス制御エレメントが不正です。有効な値を指定してください。
Invalid Access Control Element. Specify valid value.

要因

指定されたアクセス制御エレメントが不正です。

対処

有効なアクセス制御エレメントを指定して，再実行してください。

KMBJ00047-E

サブジェクト種別が不正です。有効な値を指定してください。
Invalid subject classification. Specify valid value.

要因

指定されたサブジェクト種別が不正です。

対処

有効なサブジェクト種別を指定して，再実行してください。

KMBJ00048-E

アクセス制御エレメントの個数の上限に達しました。システム管理者に連絡してください。
Reached the maximum value of Access Control Element count. Contact System Administrator.

要因

アクセス制御エレメントの個数の上限に達しています。

対処

アクセス制御エレメントは，64個までにしてください。

KMBJ00049-E

サブジェクトの最大長に達しました。システム管理者に連絡してください。
Reached the maximum length for subject. Contact System Administrator.

要因

サブジェクトの長さが許容範囲を超えています。

対処

サブジェクトの長さは，1～254文字の範囲にしてください。

KMBJ00050-E

バインドするパブリックACLの個数の上限に達しました。システム管理者に連絡してください。
Reached the maximum value for public ACL to be bound. Contact System Administrator.

要因

バインドするパブリックACLの個数の上限を超えています。

対処

バインドするパブリックACLの個数は，10個までにしてください。

KMBJ00051-E

唯一のバージョンであるため，削除できません。
Cannot delete last Version Identifier.

要因

指定されたバージョンは唯一のバージョンであるため，削除できません。

対処

この操作は，実行できません。

KMBJ00052-E

セッションは有効です。再度ログインする必要はありません。
Session still valid .No need to login again.

要因

すでにログインしています。

対処

セッションは有効です。再度ログインする必要はありません。

KMBJ00053-E

指定された引数%4がnullです。有効な値を指定してください。
Specified argument %4 is null. Provide valid value.

要因

指定された引数%4がnullです。

対処

有効な値を指定してください。

KMBJ00054-E

ログアウト中にエラーが発生しました。システム管理者に連絡してください。
Error occurred while logging out. Contact System Administrator.

要因

ログアウト中にエラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00055-E

セッションの状態をチェック中にエラーが発生しました。システム管理者に連絡してください。
Error occurred while checking session status. Contact System Administrator.

要因

セッションの状態をチェック中にエラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00056-E

オブジェクトの型%4が不正です。有効な値を指定してください。
Invalid Object type %4. Specify valid value.

要因

指定されたオブジェクトの型が不正です。%4

対処

有効なオブジェクトの型を指定して，再実行してください。

KMBJ00057-E

インデクスが不正です。有効な値を指定してください。
Invalid Index . Specify valid value.

要因

指定されたインデクスが不正です。

対処

有効なインデクスを指定してください。

KMBJ00058-E

指定されたプロパティ%4が見付かりません。有効なプロパティを指定してください。
The specified Property %4 is not found. Specify a valid Property value.

要因

指定されたプロパティ%4が見つかりません。

対処

存在するプロパティを指定して，再実行してください。

KMBJ00059-E

ファイル%4が見付かりません。有効なパス・ファイルを指定してください。
File %4 not Found. Specify a valid path / file.

要因

指定されたファイル%4が見つかりません。

対処

存在するファイルを指定してください。

KMBJ00060-E

リンクタイプが不正です。有効なリンクタイプを指定してください。
Invalid Link Type. Specify valid link type.

要因

指定されたリンクタイプが不正です。

対処

有効なリンクタイプを指定してください。

KMBJ00061-E

要求されたファイルに対してアクセス権がありません。システム管理者に連絡してください。
No Access permission for the requested file. Contact System Administrator.

要因

要求されたファイルに対してアクセス権がありません。

対処

アクセス権を見直して，再実行してください。

KMBJ00062-E

指定されたクラス名%4が見付かりません。有効なクラス名を指定してください。
The specified class name %4 is not found. Specify valid class name.

要因

指定されたクラス名%4が見つかりません。

対処

有効なクラス名を指定して，再実行してください。

KMBJ00063-E

環境変数EDMCLASSDEFPATHに空白が指定されています。正しい値を指定してください。
Blank specified for EDMCLASSDEFPATH environment variable. Set the value properly.

要因

環境変数EDMCLASSDEFPATHに空白が指定されています。

対処

環境変数EDMCLASSDEFPATHに正しい値を指定してください。

KMBJ00064-E

環境変数EDMCLASSDEFPATHに値が設定されていないか，値が不正です。正しい値を指定してください。
EDMCLASSDEFPATH variable not set or the path is invalid. Set the value properly.

要因

環境変数EDMCLASSDEFPATHに値が設定されていないか，値が不正です。

対処

環境変数EDMCLASSDEFPATHに正しい値を指定してください。

KMBJ00065-E

指定されたファイルに対する読み取り権がありません。システム管理者に連絡してください。
No Read permission for the specified file. Contact System Administrator.

要因

クラス定義情報ファイルに対する読み取り権がありません。

対処

ファイルのアクセス権を見直して，再実行してください。

KMBJ00066-E

指定されたファイルはクラス定義情報ファイルではありません。有効なファイルを指定してください。
The specified file is not a Class-Definition Information file. Specify a valid file.

要因

指定されたファイルはクラス定義情報ファイルではありません。

対処

クラス定義情報ファイルを指定してください。

KMBJ00067-E

環境変数EDMCLASSDEFPATHに指定されたディレクトリが存在しないか，アクセスできません。有効な値を指定してください。
The directory specified in the EDMCLASSDEFPATH environment variable does not exist or cannot be referenced. Specify a valid value.

要因

環境変数EDMCLASSDEFPATHに指定されたディレクトリが存在しないか，アクセスできません。

対処

操作を実行する前に，有効なディレクトリパスを指定してください。

KMBJ00068-E

ファイルの内容が不正です。変換処理が必要です。
Invalid File status. Conversion process is to be done on the file.

要因

指定されたファイルの内容は変換処理されていないため，空の状態です。

対処

変換処理を実行して，空の状態を回避してください。

KMBJ00069-E

XMLファイルの内容が不正です。XMLの構文解析でエラーが発生しました。
Improper contents in the XML file. Error occurred during the XML file syntax analysis process.

要因

XMLの構文解析でエラーが発生しました。

対処

XMLファイルの内容を確認してください。

KMBJ00070-E

パラメタのクラス名又はプロパティの組み合わせが不正です。有効な値を指定してください。
The parameters Class Name and/or Property Set values are invalid.Specify proper values.

要因

パラメタのクラス名またはプロパティの組み合わせが不正です。

対処

有効なクラス名とプロパティの組み合わせを指定してください。

KMBJ00071-W

@ を付けたプロパティが指定されています。
Properties with @ Mark are specified.

要因

@を付けたプロパティが，バージョン付きオブジェクトに対して指定されています。

対処

@を付けたプロパティを，バージョン付きオブジェクトに対して指定しないでください。

KMBJ00072-E

サポートしていないURLプロトコルです。file:///で始まっているか確認してください。
Unsupported URL protocol is used. Confirm whether URL starts by file:///.

要因

サポートしていないURLプロトコルです。

対処

file:///で始まっているか確認してください。

KMBJ00073-E

ファイル転送サービスへのセッションが切断されました。ネットワーク環境を確認してください。又は，時間をおいて，再度実行してください。
The file transfer service session is disconnected.Confirm network environment or re-execute after some time.

要因

ファイル転送サービスへのセッションが切断されました。

対処

ネットワーク環境を確認してください。または，時間をおいて，再度実行してください。

KMBJ00074-E

ファイル転送サービスに同時に接続できるセッション数の上限に達しています。時間をおいて，Connectユーザ数が減った後，再度実行してください。又は，ファイル転送サービス環境定義ファイルのFtpSessionMaxエントリを見直してください。
The limit of number of sessions that can be connected simultaneously to file transfer service has reached.Execute the process again after some time when number of user connected reduces or change FtpSessionMax entry of FTP service environment definition file.

要因

ファイル転送サービスに同時に接続できるセッション数の上限に達しています。

対処

時間をおいて，Connectユーザ数が減ったあと，再度実行してください。または，ファイル転送サービス環境定義ファイルのFtpSessionMaxエントリを見直してください。

KMBJ00075-E

ファイル転送サービスが利用できません。サーバのバージョンに対応したクライアントを利用してください。システム管理者に連絡してください。
File transfer service is not available.Use client corresponding to server version.Contact System Administrator.

要因

ファイル転送サービスが利用できません。

対処

サーバのバージョンに対応したクライアントを利用してください。

KMBJ00076-E

使用できるファイル転送サービスがありません。
File transfer service cannot be used.

要因

使用できるファイル転送サービスがありません。

対処

ネットワーク環境を確認してください。

_HIEDMS_FTPMODE=STATICを指定してファイル転送サービスが開始されているかどうかを，確認してください。

時間をおいて，再度実行してください。

ファイル転送サービスのセットアップコマンドが実行されているかどうかを，確認してください。

KMBJ00077-E

ファイルのURLが不正です。正しいURLを指定してください。
The URL for the file is invalid. Provide correct URL.

要因

ファイルのURLが不正です。

対処

URLの内容を見直してください。

KMBJ00078-E

現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。
Logical connection to database is lost. Operation cannot be performed.

要因

現在のオブジェクトからデータベースへの論理的な接続が失われました。操作は完了できません。

対処

文書空間に再接続してください。

KMBJ00079-E

指定されたバージョンは存在しません。バージョン識別子を見直してください。
The specified version does not exist. Reconsider the specified version Id.

要因

指定されたバージョンは存在しません。

対処

正しいバージョンを指定して，操作を再度実行してください。

KMBJ00080-E

使用できるサービスプロセスがありません。システム管理者に連絡してください。
There is no usable service process. Contact System Administrator.

要因

使用できるサービスプロセスがありません。

対処

時間をおいて，再度実行してください。

KMBJ00081-E

ネットワーク環境でエラーが発生しました。システム管理者に連絡してください。
Error occurred in the network environment. Contact System Administrator.

要因

ネットワーク環境でエラーが発生しました。

対処

ネットワーク環境を確認してください。

KMBJ00082-E

サーバのバージョンが対応していないため，接続できません。システム管理者に連絡してください。
The connection to incompatible server is not possible. Contact System Administrator.

要因

サーバのバージョンが対応していないため，接続できません。

対処

サーバのバージョンに対応したクライアントライブラリを利用してください。

KMBJ00083-E

制約違反の操作です。システム管理者に連絡してください。
An operation violating the restrictions is been performed. Contact System Administrator.

要因

制約違反の操作です。

対処

この操作は実行できません。

KMBJ00084-E

この操作を実行するために必要なネットワークが利用できません。システム管理者に連絡してください。
The network cannot be used to perform this operation. Contact System Administrator.

要因

この操作を実行するために必要なネットワークが利用できません。

対処

この操作は実行できません。

KMBJ00085-E

オブジェクトが初期化されていません。初期化してから再実行してください。
Object is not initialized. Re-execute after initialization.

要因

オブジェクトが初期化されていません。

対処

初期化を実行してください。

KMBJ00086-E

DMA規約で禁止されている操作です。
This operation is prohibited by DMA agreement.

要因

DMA規約で禁止されている操作です。

対処

この操作は実行できません。

KMBJ00087-E

開始インデクスが不正です。正しい開始インデックスを指定してください。
The start index is invalid. Provide proper start index.

要因

開始インデクスが不正です。

対処

正しい開始インデクスを指定してください。

KMBJ00088-E

ブロックサイズに0は指定できません。正しいブロックサイズを指定してください。
The block size cannot be zero.Provide proper block size.

要因

ブロックサイズに0は指定できません。

対処

正しいブロックサイズを指定してください。

KMBJ00089-W

fetchカウントが許容範囲を超えています。
The Fetch Count has gone out of range.

要因

fetchカウントが許容範囲を超えています。

KMBJ00090-W

構成管理型のコンテインメント（FIXモード又はFLOATINGモード）は，解除できません。
Cannot unlink VT Fix / Float links.

要因

構成管理型のコンテインメント（FIXモードまたはFLOATINGモード）を解除しようとしました。

KMBJ00091-W

レンディション定義の初期化に失敗しました。
Mime Map Manager Initialization failed.

要因

レンディション定義ファイルの読み込み中に，エラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00092-E

指定されたプロパティの値が不正です。
Value specified by the user for property is invalid.

要因

不正な値のプロパティが指定されました。

対処

正しい値を指定してください。

KMBJ00093-E

文書は，既にチェックアウトされています。
The document is already checked out.

要因

文書は，すでにチェックアウトされています。

対処

文書をチェックインしてから，操作してください。

KMBJ00094-E

指定されたフェッチカウントが不正です。正しいフェッチカウントを指定してください。
Specified Fetch Count is invalid. Specify a valid Fetch Count.

要因

指定されたフェッチカウントが不正です。

対処

正しいフェッチカウントを指定してください。

KMBJ00095-E

文書空間オブジェクトは，指定されたパブリックACLで，既にバインドされています。
Document space object is already bound with the specified public ACL.

要因

文書空間オブジェクトは，指定されたパブリックACLで，すでにバインドされています。

対処

指定したパブリックACLを見直してください。

KMBJ00096-E

指定されたedmSQL文が不正です。理由：%4正しいedmSQL文を指定してください。
Specified edmSQL statement is incorrect, Reason: %4. Specify valid edmSQL statement.

要因

指定されたedmSQL文が不正です。理由：%4。

対処

正しいedmSQL文を指定してください。

KMBJ00097-E

指定された?パラメタの値が不正です。正しい?パラメタの値を指定してください。
Specified '?' parameter value is incorrect. Specify valid '?' parameter value.

要因

指定された?パラメタの値が不正です。

対処

正しい?パラメタの値を指定してください。

KMBJ00098-E

引数で指定されたパラメタ数は，edmSQL文で指定された?パラメタ数より大きいです。正しいパラメタを指定してください。
The number of parameters specified as argument is greater than the number of '?' parameters specified in edmSQL statement. Specify valid parameter.

要因

引数で指定されたパラメタ数は，edmSQL文で指定された?パラメタ数より大きいです。

対処

正しいパラメタを指定してください。

KMBJ00099-E

フェッチカウントの最大値が不正です。正しい値を指定してください。
The value of max fetch count is invalid. Provide a valid value.

要因

フェッチカウントの最大値が不正です。

対処

正しい値を指定してください。

KMBJ00100-E

XMLライブラリのローディング処理に失敗しました。
An error occurred during Loading of the library.

要因

XMLライブラリのローディング処理に失敗しました。

対処

XML管理機能に必要な環境変数が設定されているかどうか確認してください。

KMBJ00101-E

指定されたアクセス制御モードが不正です。正しい値を指定してください。
The value specified for ACL mode is invalid. Provide a valid value.

要因

不正なアクセス制御モードが指定されました。

対処

正しいアクセス制御モードを指定してください。

KMBJ00102-E

指定されたコンパレータの値が不正です。正しい値を指定してください。
Specified comparator is invalid. Provide valid comparator value.

要因

指定されたコンパレータの値が不正です。

対処

正しい値を指定してください。

KMBJ00103-E

指定されたカーソルの位置が不正です。正しい値を指定してください。
Specified cursor level is invalid. Provide a valid value.

要因

指定されたカーソルの位置が不正です。

対処

正しい値を指定してください。

KMBJ00104-E

指定されたオブジェクトに対して，実行された操作が不正です。名前なし検索結果集合に対して，カラム名の指定はできません。
The operation performed is invalid for the specified object. The resultset object is unnamed, and hence, column name cannot be specified.

要因

名前なし検索結果集合に対して，カラム名が指定されました。

対処

カラム名ではなく，列インデクスで指定してください。

KMBJ00105-E

パブリックACLのリストの要素にnullが指定されました。
A null element is specified in the public ACL list.

要因

パブリックACLのリストの要素の一つ以上が，nullです。

対処

正しい要素を指定してください。

KMBJ00106-E

GetVersionObjListメソッドに指定したorderが不正です。正しいorderを指定してください。
Order specified in GetVersionObjList() is invalid. Specify correct order.

要因

GetVersionObjListメソッドに不正なorderが指定されました。

対処

正しいorderを指定してください。

KMBJ00107-E

指定されたクラス名は，255文字を超えています。
The length of specified class name exceeds 255 characters.

要因

指定されたクラス名が，255文字を超えています。

対処

255文字以下のクラス名を指定してください。

KMBJ00108-E

指定されたレンディションタイプは空です。正しい値を指定してください。
Specified rendition type is empty. Provide a valid value.

要因

空のレンディションタイプが指定されました。

対処

正しい値を指定してください。

KMBJ00109-E

?パラメタリストの要素に指定されたオブジェクトタイプが不正です。正しいオブジェクトタイプを指定してください。
The specified object type passed in the element of '?' parameter list is invalid. Specify a valid object type.

要因

不正なオブジェクトタイプが，?パラメタリストの要素に指定されました。

対処

正しいオブジェクトタイプを指定してください。

KMBJ00110-E

指定されたインデクスのパスが不正です。正しいインデクスのパスを指定してください。
The specified index path is invalid. Specify a valid index path.

要因

不正なインデクスのパスが指定されました。

対処

正しいインデクスパスを指定してください。

KMBJ00111-E

リストに指定された値が不正です。正しい値を指定してください。
Specified value(s) passed in the list is/are invalid. Specify valid values.

要因

リストに不正な値が指定されました

対処

リストに正しい値を指定してください。

KMBJ00112-E

指定されたフォルダオブジェクト %4 が不正です。正しいフォルダオブジェクトを指定してください。
Specified folder object %4 is invalid. Specify a valid folder object.

要因

不正なフォルダオブジェクトが指定されました。

対処

正しいフォルダオブジェクトを指定してください。

KMBJ00113-E

文書のアップロード情報(DbjUploadInfo)がnullです。正しい文書のアップロード情報を指定してください。
The DbjUploadInfo passed is null. Specify a valid DbjUploadInfo.

要因

文書のアップロード情報(DbjUploadInfo)としてnullが指定されました。

対処

正しい文書のアップロード情報を指定してください。

KMBJ00114-E

指定されたパスが不正です。正しいパスを指定してください。
The specified file path(s) is/are invalid. Specify valid path.

要因

不正なパスが指定されました。

対処

正しいパスを指定してください。

KMBJ00115-E

不正な引数が指定されました。(Method=%4)
IllegalArgument is specified(Method=%4).

要因

指定された引数が不正です。

対処

正しい引数を指定してください。

KMBJ00116-W

logoutメソッドが呼ばれていないため，自動的にlogoutメソッドを実行しました。
Logout method has not been called, so the Logout method has been called automatically.

要因

logoutメソッドが実行されていなかったため，logoutメソッドが実行されました。

KMBJ00117-E

指定されたリンク識別子が不正です。正しい値を指定してください。
Specified Link ID is invalid. Specify valid link ID.

要因

不正なリンク識別子が指定されました。

対処

正しいリンク識別子を指定してください。

KMBJ00118-W

レンディション定義ファイル(mime.properties)が，見つかりません。
File "mime.properties" was not found.

要因

レンディション定義ファイル(mime.properties)が，見つかりません。

対処

レンディション定義ファイル(mime.properties)を作成してください。

KMBJ00119-E

DbjUploadInfoインタフェースのメソッドで指定されたファイルのパスが不正です。正しいパスを指定してください。
The file path specified in DbjUploadInfo is null. Specify a valid file path.

要因

DbjUploadInfoインターフェースのメソッドに不正なパスが指定されました。

対処

正しいパスを指定してください。

KMBJ00120-E

指定された操作が失敗しました。
The specified operation has failed.

要因

指定された操作が失敗しました。次のどれかの要因が考えられます。

操作が失敗しました。

メタ情報ファイルが不正です。

メモリ不足で実行できません。

対処

次のどれかの方法で対処してください。

時間をおいて再度実行するか，処理を見直してください。

メタ情報ファイルを見直してください。

メモリを増設してください。またはメモリを大量に消費しているアプリケーションを停止させて，処理を再実行してください。

KMBJ00121-E

ログインが失敗しました。
Login failed.

要因

DocumentSpace構成定義ファイルのProcessOrbBoaOptionエントリに，-OAthreadMaxオプションを129以上の値で指定している環境で，同時に129以上のクライアントからDbjSession#loginが実行されました。

対処

時間をおいて再度実行するか，-OAthreadMaxオプションの値を128以下にしてください。

KMBJ00122-E

制限時間を超えました。
The restricted time is exceeded.

要因

制限時間を超えました。

対処

ログインしてから，再度実行してください。

KMBJ00123-E

XMLの定義情報が不正です。
The XML definition information is invalid.

要因

XMLの定義情報が不正です。

対処

XMLの定義情報を見直してください。

KMBJ00124-E

接続先サーバでエラーが発生しました。(Major Code:%4, Minor Code:%5)
Error occurred in connected server(Major Code : %4 and Minor Code:%5).

要因

DocumentBrokerでエラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00125-E

コンテンツの操作でエラーが発生しました。
Error occurred in the contents operation.

要因

コンテンツの操作でエラーが発生しました。

対処

システム管理者に連絡してください。

KMBJ00126-E

オブジェクトとコンテンツの状態が不整合です。
The state of contents and the object is mismatched.

要因

オブジェクトとコンテンツの状態が不整合です。

対処

システム管理者に連絡してください。

KMBJ00127-E

リファレンスタイプが不正です。正しいリファレンスタイプを指定してください。
Specified reference type is invalid. Specify the valid reference type.

要因

リファレンス種別が不正です。

対処

システム管理者に連絡してください。

KMBJ00128-E

相対パスのベースとなるパスが指定されていません。相対パスのベースとなるパスを指定してください。
The path used as the base of relative path is not specified. Specify the path used as the base of relative path.

要因

相対パスのベースとなるコンテンツ格納先ベースパスが設定されていません。

対処

システム管理者に連絡してください。

KMBJ00129-E

指定したコンテントタイプが不正です。正しい文書オブジェクトを指定してください。
Specified content type is invalid. Specify valid document object.

要因

指定したコンテンツ種別が不正です。

対処

システム管理者に連絡してください。

KMBJ00132-E

カレントバージョンのコンテンツが存在しません。
The contents of current version is not found.

要因

カレントバージョンのコンテンツが存在しません。

対処

システム管理者に連絡してください。

KMBJ00133-E

コンテンツが登録されていません。
The contents is not registered.

要因

コンテンツが登録されていません。

対処

コンテンツを登録してから処理を行ってください。

KMBJ00134-E

開始インデクスが不正です。0以上の開始インデクスを指定してください。
The start index is invalid. Provide start index of 0 or more.

要因

開始インデクスが不正です。

対処

0以上の開始インデクスを指定してください。

付録

＜この付録の構成＞

付録A　文書空間で使用する文字コード種別がUTF-8の場合の機能差異

付録B　用語解説

付録A　文書空間で使用する文字コード種別がUTF-8の場合の機能差異

ここでは，文書空間で使用する文字コード種別がUTF-8の場合のクラス，インターフェースおよびメソッドの機能差異について説明します。なお，文書空間で使用する文字コード種別がShift-JISの場合は，すべてのクラス，インターフェースおよびメソッドを使用できます。

＜この節の構成＞

(1)　ファクトリクラスのメソッド

(2)　パラメタクラスのメソッド

(3)　文書管理クラスのメソッド

(4)　メタクラスのメソッド

(5)　例外クラス

(6)　定数定義クラス

(7)　ライブラリ情報取得クラスのメソッド

(8)　トレースクラスのメソッド

(1)　ファクトリクラスのメソッド

文書空間で使用する文字コード種別がUTF-8の場合，次のメソッドは使用できません。

DbjFactoryインターフェース

createXmlTranslatorメソッド

createXmlUploadInfoメソッド

そのほかのメソッドはすべて使用できます。

(2)　パラメタクラスのメソッド

文書空間で使用する文字コード種別がUTF-8の場合，次のメソッドは使用できません。

DbjMappedPropインターフェース

getClassListメソッド

propSetメソッド

DbjXmlUploadInfoインターフェース

getFilterFilePathメソッド

getIndexTypeメソッド

getMappingIdメソッド

getParseLevelメソッド

setFilterFilePathメソッド

setIndexTypeメソッド

setMappingIdメソッド

setParseLevelメソッド

clearParseMessageメソッド

getParseMessageメソッド

そのほかのメソッドはすべて使用できます。

(3)　文書管理クラスのメソッド

文書空間で使用する文字コード種別がUTF-8の場合，次のメソッドは使用できません。

DbjXmlTranslatorインターフェース

getMappedPropertiesメソッド

そのほかのメソッドはすべて使用できます。

(4)　メタクラスのメソッド

文書空間で使用する文字コード種別がUTF-8の場合，すべてのメソッドが使用できます。

(5)　例外クラス

文書空間で使用する文字コード種別がUTF-8の場合，すべてのクラスが使用できます。

(6)　定数定義クラス

文書空間で使用する文字コード種別がUTF-8の場合，すべてのクラスが使用できます。

(7)　ライブラリ情報取得クラスのメソッド

文書空間で使用する文字コード種別がUTF-8の場合，すべてのメソッドが使用できます。

(8)　トレースクラスのメソッド

文書空間で使用する文字コード種別がUTF-8の場合，すべてのメソッドが使用できます。

付録B　用語解説

Java クラスライブラリで使用する用語について説明します。

ここで説明していないJava クラスライブラリの用語については，マニュアル「DocumentBroker Version 3　システム導入・運用ガイド」を参照してください。

（記号）

?パラメタ

edmSQL文中のパラメタ値を，検索条件を指定するときには固定しないでおいて，検索実行時にアプリケーションから値を設定するために使用するパラメタです。edmSQL文中の?パラメタによって値を渡す個所には，定数を指定する代わりに「?」を指定しておきます。

Java クラスライブラリでは，DbjQParamインターフェースのサブインターフェースによって，?パラメタの値を設定できます。

（英字）

ACE

Access Control Elementの略です。アクセス制御エレメントのことです。

ACFlag

Access Control Flagの略です。アクセス制御フラグのことです。

ACL

Access Control Listの略です。アクセス制御リストのことです。

AND条件

検索条件同士の論理積を求める結合条件です。例えば，「著者が『日立太郎』で，文書のコンテンツ中に『コンピュータ』という文字列を含む文書を検索する」というような場合に使用できます。

API（Application Programming Interface）

アプリケーションプログラムとのインターフェースです。

ContainerVersionオブジェクト

DMAクラスのedmClass_ContainerVersionクラスまたはそのサブクラスを基に作成されたDMAオブジェクトです。

Containerオブジェクト

DMAクラスのdmaClass_Containerクラス，またはedmClass_ContainerVersionクラス以外のdmaClass_Containerクラスのサブクラスを基に作成されたDMAオブジェクトです。

CORBA（Common Object Request Broker Architecture）

OMG（Object Management Group）が提唱するオブジェクト間の通信メカニズムを提供するORB（Object Request Broker）の標準アーキテクチャです。

DMA（Document Management Alliance）

文書管理インターフェースの標準化を図る団体AIIM（Association for Information and Image Management International）によって定義される共通インターフェースです。

dmaClass_ConfigurationHistoryクラス

バージョン管理に使用するDMAクラスです。

dmaClass_ConfigurationHistoryクラスまたはそのサブクラスは，バージョニングオブジェクトのトップオブジェクトクラスになります。

dmaClass_Containerクラス

オブジェクトをディレクトリに格納するイメージでリンクしてまとめて管理したり，オブジェクトに分類を付けるイメージでリンクして関連付けて管理したりできるフォルダを表すDMAクラスです。

dmaClass_Containerクラスまたはそのサブクラスは，構成管理できないバージョンなしフォルダのトップオブジェクトクラスになります。

dmaClass_DocVersionクラス

文書を表すDMAクラスです。

dmaClass_DocVersionクラスまたはそのサブクラスは，バージョンなし文書のトップオブジェクトクラスになります。また，構成管理できないバージョン付き文書のバージョンオブジェクトのトップオブジェクトクラスになります。

DMAオブジェクト

DMAクラスを基に作成されたオブジェクトです。

DMAクラス

DMAのオブジェクトモデルに基づいたクラス，DocumentBrokerで定義しているクラスおよびそのサブクラスです。Java クラスライブラリの文書空間オブジェクトクラスのプロパティは，DMAクラスに定義します。

DocVersionオブジェクト

DMAクラスのdmaClass_DocVersionクラス，またはedmClass_VersionTracedDocVersionクラス以外のdmaClass_DocVersionクラスのサブクラスを基に作成されたDMAオブジェクトです。

edmClass_ContainerVersionクラス

オブジェクトのまとまりをバージョン管理できるフォルダを表すDMAクラスです。オブジェクトをディレクトリに格納するイメージでリンクしてまとめて管理したり，オブジェクトに分類を付けるイメージでリンクして関連付けて管理したりできるフォルダを表すDMAクラスです。また，構成管理型リンクを利用して構成要素であるバージョン付き文書の特定バージョンを固定してリンクしたり，常に最新バージョンをトレースしてリンクしたりもできます。

edmClass_ContainerVersionクラスまたはそのサブクラスは，バージョンなしフォルダのトップオブジェクトクラスになります。また，バージョン付きフォルダのバージョンオブジェクトのトップオブジェクトクラスになります。

edmClass_IndependentPersistenceクラス

独立データを表すDMAクラスです。

edmClass_IndependentPersistenceクラスまたはそのサブクラスは，独立データのトップオブジェクトクラスになります。

edmClass_PublicACLクラス

パブリックACLを表すDMAクラスです。文書やフォルダなどのオブジェクトとは独立に作成・参照でき，複数の文書やフォルダなどのオブジェクトから共有できるアクセス制御情報を表すクラスです。

パブリックACLのトップオブジェクトクラスになります。

edmClass_Relationshipクラス

文書間リンクを表すDMAクラスです。単独では作成できない，文書に従属するRelationshipオブジェクトの基となるDMAクラスです。

edmClass_VersionTracedDocVersionクラス

文書を表すDMAクラスです。

edmClass_VersionTracedDocVersionクラスまたはそのサブクラスは，バージョン付き文書のバージョンオブジェクトのトップオブジェクトクラスになります。

edmSQL

文書空間オブジェクトを検索する場合に使用する，検索条件式を表現するための文法です。SQLの文法に基づいています。

edmSQL検索

検索条件に，SQLの文法に基づいた文法で記述できるedmSQL文を指定して実行する検索のことです。

getterメソッド

パラメタクラスのインターフェースで扱うオブジェクトのプロパティの値を取得するためのメソッドです。

GUID

Globally Unique Identifierの略です。DMAのクラス，プロパティなどに与えるユニークな識別子です。GUIDは，「X」を0～9，a～f（小文字），およびA～F（大文字）で表される16進数とした「XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8けた-4けた-4けた-4けた-12けた）」の形式で表されます。

Java クラスライブラリ

DocumentBrokerサーバにアクセスするユーザアプリケーションプログラムをJava言語で作成するために，DocumentBroker Development KitおよびDocumentBroker Runtimeが提供しているインターフェースです。

MIME形式

MIME::text/plain，MIME::text/htmlなど，コンテンツのレンディションタイプを表す形式です。なお，DocumentBrokerでは，「MIME::」は省略して指定します。

NOT条件

指定したキーワードとの不一致を求める検索条件です。例えば，「作成者が『日立』ではない文書を検索する」というような場合に使用できます。

OIID

Object Instance Identifierの略です。データベースに格納されたオブジェクトの存在や格納位置などを明確にするために，各オブジェクトに与えるユニークな識別子です。

OR条件

検索条件同士の論理和を求める結合条件です。例えば，「作成者が『日立太郎』である文書空間オブジェクトか，作成者の所属が『日立製作所』である文書空間オブジェクトを検索する」という場合，「文書のコンテンツ中に『コンピュータ』という文字列を含むか，『インターネット』という文字列を含む文書を検索する」という場合に使用できます。

Proxyオブジェクト

文書空間オブジェクトを操作する場合に使用する代理オブジェクトです。Java クラスライブラリでは，文書空間オブジェクトを操作するとき，文書空間オブジェクトを直接操作するのではなく，Proxyオブジェクトを操作することで間接的に操作します。

Proxyオブジェクトはメモリ空間に存在します。不要になった場合は，Javaのガベージコレクションによって削除されます。

setterメソッド

パラメタクラスのインターフェースで扱うオブジェクトのプロパティの値を設定するためのメソッドです。

VARRAY型

文書空間オブジェクトのプロパティのデータ型の一つです。VARRAY型のプロパティは，プロパティのデータ型に従った複数の値を可変長な一次元配列として持ちます。

VersionTracedDocVersionオブジェクト

DMAクラスのedmClass_VersionTracedDocVersionクラスまたはそのサブクラスを基に作成されたDMAオブジェクトです。

W3C（World Wide Web Consortium）

HTMLやXMLなど，WWWに関する技術の標準化を推進する非営利団体です。

XMLインデクスデータ作成機能

XML文書のコンテンツからインデクスデータを作成して，XML文書のプレーンテキスト形式の全文検索インデクスまたは構造指定検索用の全文検索インデクスを登録する機能です。XML文書の構文解析やタグ情報の除去もあわせて実行できます。

XML構造指定検索

XML文書のDTDで記述した論理構造（エレメント）やエレメントの属性をキーにして，XML文書を全文検索する方法です。例えば，「タイトルに『コンピュータ』という単語が含まれ，章に『XML』という単語が含まれる文書を検索する」というような場合に使用します。また，「『document』というエレメントに設定されている属性『status』の属性値が『public』である文書を検索する」というような場合にも使用できます。

XMLトランスレーターオブジェクト

DbjXmlTranslatorインターフェースを取得したときにメモリ空間に作成される概念的なオブジェクトです。DbjXmlTranslatorインターフェースの機能を実行できます。

XMLプロパティマッピング機能

XML文書を構文解析して，DocumentBrokerサーバのプロパティマッピング定義ファイルの定義に従ってXML文書内のタグ間の文字列または属性値をXML文書のプロパティに割り当てて設定する機能です。

XMLプロパティマッピング結果情報

XMLプロパティマッピング機能で作成される情報です。DbjMappedPropインターフェースで扱います。

XML文書のアップロード情報

XML文書作成またはコンテンツ更新時に使用する情報です。XML文書作成時に，XMLプロパティマッピング機能およびXMLインデクスデータ作成機能を実行するために使用できます。また，XML文書のコンテンツ更新時にXMLインデクスデータ作成機能を実行するために使用できます。DbjXmlUploadInfoインターフェースで扱います。

（ア行）

アクセス権

文書空間オブジェクトを作成したり，すでに作成されているオブジェクトにアクセスしたりする権利です。

アクセス制御エレメント（ACE：Access Control Element）

アクセス制御リスト（ACL）の要素です。一つのサブジェクトと一つのパーミッションの組で構成され，指定されたサブジェクトに対して指定されたパーミッションの範囲のアクセス権を与えることを示す情報です。

アクセス制御機能

DocumentBrokerの文書空間での文書空間オブジェクトの作成や，管理されている文書やフォルダなどの文書空間オブジェクトに対する操作を，ユーザやグループごとに許可または制限する機能です。

アクセス制御機能付き検索

アクセス制御機能を利用した文書空間で検索を実行した場合に，ユーザにアクセス権がない文書空間オブジェクトを検索結果として取得しない検索です。

アクセス制御情報

アクセス制御されている文書空間で，ユーザがメソッドを実行する際に，アクセス権の判定に使用される情報です。

アクセス制御情報変更権

文書空間オブジェクトに設定されているアクセス制御情報（ACFlagおよびACL）を変更する権利です。また，パブリックACLをアクセス制御対象の文書空間オブジェクトに設定することを許可する権利も含みます。なお，パブリックACLのアクセス情報変更権には，パブリックACLのユーザ定義プロパティの値を変更する権利を含みます。

アクセス制御フラグ（ACFlag：Access Control Flag）

文書空間オブジェクトの所有者，プライマリグループおよび全ユーザという区分でパーミッションを設定できるアクセス制御情報の一つです。

アクセス制御リスト（ACL：Access Control List）

任意のユーザまたはグループにパーミッションを設定できるアクセス制御情報の一つです。アクセス制御エレメント（ACE）のリストで構成されます。

アンバインド

パブリックACLとのバインドを解除することです。

異表記展開検索

全文検索条件として指定する検索タームまたは検索タームの異表記を含む文書を検索する全文検索のオプションです。例えば，検索タームとして「バイオリン」を指定した場合に，「ヴァイオリン」という検索タームの異表記を含む文書も検索できます。

インターフェース

Java クラスライブラリの機能を実行するためのメソッドが定義されている，クラスの仕様です。Java クラスライブラリでは，オブジェクトを操作するとき，まず，インターフェースを取得して，そのインターフェースで定義されているメソッドを実行する，という手順で操作します。

永続オブジェクト

データベースに格納されたオブジェクトです。

永続プロパティ

データベースに存在するプロパティです。

オーナーオブジェクトプロパティ

リンクProxyオブジェクトのプロパティです。ターゲットリンクオブジェクトによってリンクが設定されている文書空間オブジェクトのうち，リンク元である文書空間オブジェクトのProxyオブジェクトが設定されます。

オブジェクト作成権

オブジェクト作成権限で，文書空間オブジェクトを作成する権利を与えるパーミッションです。ユーザ権限定義ファイルに指定します。

オブジェクト作成権限

文書空間オブジェクトを作成する権限で，ユーザ権限の一つです。ユーザ権限定義ファイルで定義します。オブジェクト作成権限を与えられたユーザおよびグループに属するユーザは，文書空間オブジェクトを作成するメソッドを実行できます。

オブジェクト種別

文書空間オブジェクトの種類を表す定数です。オブジェクト種別には，バージョンなし文書，バージョン付き文書，バージョンなしフォルダ，バージョン付きフォルダ，独立データおよびパブリックACLがあります。

オブジェクト種別プロパティ

Proxyオブジェクトのプロパティです。ターゲットオブジェクトのオブジェクト種別が設定されます。

オブジェクト操作権限

文書空間内のすべての文書空間オブジェクトを，与えられた権限の範囲で操作する権利です。ユーザ権限の一つです。ユーザ権限定義ファイルで定義します。例えば，オブジェクト操作権限として基本プロパティ参照権を与えられたユーザおよびグループに属するユーザは，文書空間内のすべての文書空間オブジェクトのプロパティを参照できます。

オブジェクトリファレンス

DMAオブジェクトへのリファレンスを示すプロパティの値です。例えば，dmaProp_ParentContainerプロパティの値がこれに当たります。Java クラスライブラリのメソッドでこの値を使用することはできませんが，edmSQL文中では使用することができます。

（カ行）

下位オブジェクト

フォルダを使用した文書管理をする場合に，フォルダからリンクを設定されている，リンク先オブジェクトです。例えば，文書をフォルダに格納する管理をしている場合は，文書が下位オブジェクトです。

概念検索

ユーザが任意に指定した文章や文字列を手がかりにして，その条件と似た概念を持つ文書を検索する方法です。全文検索の一種です。概念検索で指定する条件のことを種文章といいます。

可変長配列

VARRAY型のプロパティの値です。Java クラスライブラリでは，DbjVArrayインターフェースで扱います。

仮のバージョン識別子

チェックアウト中の仮のバージョンを識別するための識別子です。

チェックアウト中のオブジェクトを参照・更新するときに使用します。この識別子はチェックアウト時にDocumentBrokerによって設定される識別子であり，仮のバージョンに該当するオブジェクトのOIIDとは異なります。

カレントバージョン

バージョン付き文書またはバージョン付きフォルダが持つ複数のバージョンの中の，最新バージョンのことです。

基本コンテンツ更新権

基本パーミッションの一つで，バージョンなし文書またはバージョン付き文書のコンテンツを更新する権利を与えるパーミッションです。基本プロパティ参照権を含みます。また，全文検索インデクスを作成，削除する権利も含みます。

基本コンテンツ参照権

基本パーミッションの一つで，バージョンなし文書またはバージョン付き文書のコンテンツを参照する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本削除権

基本パーミッションの一つで，文書空間オブジェクトを削除する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本バージョン管理権

基本パーミッションの一つで，バージョン管理されている文書空間オブジェクトのバージョンを追加，削除する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本パーミッション

ユーザおよびグループが文書空間オブジェクトに対して実行できる操作の範囲を定めるパーミッションの基本単位です。オブジェクト操作権限，アクセス制御フラグおよびアクセス制御エレメントで，ユーザおよびグループに許可する操作の範囲を定める場合に使用します。例えば，あるユーザに対して，文書の更新と削除を許可する場合は，更新と削除を許可するために，基本コンテンツ更新権と基本削除権という二つのパーミッションを設定します（一つのパーミッションで一つの権利を与えます）。基本パーミッションには，基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権，基本コンテンツ更新権，基本リンク権，基本バージョン管理権および基本削除権があります。

基本プロパティ更新権

基本パーミッションの一つで，文書空間オブジェクトのプロパティを更新する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

基本プロパティ参照権

基本パーミッションの一つで，文書空間オブジェクトのプロパティを参照する権利を与えるパーミッションです。そのほかのすべての基本パーミッションに含まれます。フォルダに対して設定すると，フォルダのリンクをたどることも許可します。

基本リンク権

基本パーミッションの一つで，リンクを設定・解除する権利を与えるパーミッションです。基本プロパティ参照権を含みます。

キャッシュキー

キャッシュ付き検索を実行する場合に，2回目以降の検索条件が前回の検索条件と同じかどうかを判断するためのキーです。検索条件が同じ場合，検索結果キャッシュに対して検索が実行されます。検索条件が異なる場合，検索結果キャッシュは破棄されて，文書空間に対して検索が再度実行されます。

キャッシュ検索

検索結果キャッシュを使用する検索です。文書空間に対して検索を実行したときに，取得した検索結果をキャッシュに保存しておき，同じ検索条件の2回目以降の検索では検索結果キャッシュから検索結果を取得します。同じ検索条件で複数回検索を実行する場合に，検索結果取得処理が高速になります。例えば，10,000件検索結果がある場合に，これを検索結果キャッシュとして保存しておき，ユーザアプリケーションプログラムではこれを100件ずつ取得する，という検索ができます。

キャッシュ名

検索結果キャッシュの名称です。検索結果キャッシュは，キャッシュ名によって識別されます。

近傍条件検索

全文検索条件に複数の検索タームを指定した場合に，検索ターム間の距離を条件にして検索する方法です。例えば，「『文書管理』という検索タームと『ドキュメント』という検索タームを含み，これらの検索タームがこのとおりの順序で出現し，かつ検索ターム間に入る文字が5文字以内である文書を検索する」というような場合に使用できます。

組み合わせパーミッション

基本パーミッションを複数組み合わせた権利を与えるパーミッションの単位です。アクセス制御フラグおよびアクセス制御エレメントでユーザおよびグループに許可する操作の範囲を定める場合に使用します。組み合わせパーミッションには，プロパティ参照権，参照権，プロパティ更新権，参照更新権，削除権，リンク権，バージョン管理権およびフルコントロールがあります。例えば，あるユーザに対して，ある文書の参照更新権という組み合わせパーミッションを設定すると，そのユーザは基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権および基本コンテンツ更新権が設定されたのと同じ範囲の操作を，その文書に対して実行できます。

クラス定義情報ファイル

DocumentBrokerサーバで定義されているDMAオブジェクトのクラスまたはそのサブクラスのクラス名を取得したり，プロパティ名からGUID，データ型などの情報を取得したりするために使用するファイルです。DocumentBrokerサーバのEDMCrtSimMetaコマンドで作成できます。DMAクラスやプロパティに名前でアクセスする場合にJava クラスライブラリが参照します。

クラスディスクリプション

DMAクラスに関するメタ情報です。DMAクラスごとに定義されています。

継承

既存のクラスを利用して新しいクラスを定義するオブジェクト指向の技術です。

検索結果キャッシュ

キャッシュ付き検索実行時に作成される検索結果のキャッシュです。キャッシュ付き検索では，例えば，10,000件の検索結果がある場合に，これを検索結果キャッシュとして保存しておき，ユーザアプリケーションプログラムではこれを100件ずつ取得する，という検索ができます。

検索結果集合

検索実行時に作成される，検索条件に一致する文書空間オブジェクトの集合です。要素がプロパティ値である，行と列の二次元データに，列名や列のデータ型などのメタデータを付けたものとして表されます。検索結果集合は，DbjResultSetインターフェースで扱います。

検索結果取得情報

キャッシュ付き検索実行時に，検索結果を何件検索結果キャッシュとして保存するか，また，検索結果キャッシュから何件ユーザアプリケーションプログラムに返却するかを指定する情報です。DbjFetchInfoインターフェースで扱います。

更新系メソッド

操作対象になるオブジェクトの状態を変化させるメソッドです。文書のコンテンツの更新や，文書やフォルダのプロパティの更新を実行するメソッドなどが該当します。

構成管理型リンク

フォルダにバージョン付きオブジェクトを関連付けるときに，バージョン付きオブジェクトの特定のバージョンを固定して関連付けたり，常に最新バージョンをトレースして関連付けたりできるリンクの種別です。構成管理モードとして，FIXモードとFLOATINGモードがあります。

構造指定検索

XML文書を管理している場合に，文書の論理構造や構造の属性をキーとして検索する方法です。例えば，「タイトルに『コンピュータ』という単語が含まれ，章に『XML』という単語が含まれる文書を検索する」というような場合に使用します。また，「『document』というエレメントに設定されている属性『status』の属性値が『public』である文書を検索する」というような場合にも使用できます。

コレクション

java.util.Collectionインターフェースの仕様に従うオブジェクトです。要素オブジェクトの集合を表します。

コンテンツ

文書のデータ部分を指します。DMAで規定されているコンテンツ管理モデルに従ってアクセスされるオブジェクトの実体（例えば，report.doc，document.htmなど）です。

コンテンツ情報

文書のコンテンツ管理モデルで管理されているコンテンツに関する情報です。ファイル名およびレンディションタイプが管理されています。DbjContentInfoインターフェースで扱います。

（サ行）

削除権

組み合わせパーミッションの一つです。基本削除権と同じ操作を許可するパーミッションです。

サブインターフェース

あるインターフェースから派生するインターフェースのことです。上位インターフェースで定義されているメソッドを継承します。

サブクラス

あるクラスから派生するクラスのことです。または，それ自身がサブクラスとして参照されているクラスのことです。

サブジェクト

アクセス権を与えるユーザまたはグループです。

サブジェクト種別

アクセス権を与えるサブジェクトが，ユーザなのか，グループなのかまたはシステムなのかを識別するための情報です。

サブレンディション

マルチレンディション文書のマスタレンディション以外のレンディションです。なお，サブレンディションは，登録後にマスタレンディションに変更できます。

参照型リンク

一つのオブジェクトから複数のバージョンなしフォルダまたはバージョン付きフォルダを親として関連付けるリンクの種別です。一つの文書に対して複数の分類を付けるイメージでの管理を実現します。

参照系メソッド

操作対象になるオブジェクトの状態を変化させないメソッドです。文書のコンテンツの参照や，文書やフォルダのプロパティの参照を実行するメソッドなどが該当します。

参照権

組み合わせパーミッションの一つです。基本コンテンツ参照権と同じ操作を許可するパーミッションです。

参照更新権

組み合わせパーミッションの一つです。基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権および基本コンテンツ更新権を組み合わせたパーミッションです。すなわち，参照更新権を設定することで，プロパティを参照，更新する権利とコンテンツを参照，更新する権利を設定できます。

サンプルWebアプリケーション

DocumentBroker Development KitおよびDocumentBroker Runtimeがサンプルとして提供しているアプリケーションプログラムです。Java クラスライブラリを使用して開発されたコンポーネントで構成されています。

ユーザアプリケーションプログラムを開発する際に，アプリケーションプログラムのアーキテクチャを参考にできます。また，Java クラスライブラリのクラス，インターフェース，メソッドなどの具体的な使用方法について参考にできます。

システム管理者

DocumentBrokerの運用，管理および保守をするユーザです。DocumentBrokerの実行環境を設定することができます。

上位オブジェクト

フォルダを使用した文書管理をする場合のリンク元オブジェクトです。つまり，フォルダのことです。

状態フラグ

マルチレンディション文書で，マスタレンディションに対するサブレンディションのコンテンツの状態を表すフラグです。マスタレンディションとサブレンディションのコンテンツの状態が一致している，マスタレンディションのコンテンツが更新されたのに対してサブレンディションのコンテンツが更新されていない，またはサブレンディションのコンテンツが存在しない，という3種類の状態が表されます。dbrProp_RenditionStatusプロパティの下位2バイトに設定されます。

所有者

文書空間オブジェクトの所有者として設定されているユーザです。アクセス制御フラグでアクセス権を与えられます。所有者に設定されているユーザは，その文書空間オブジェクトのアクセス制御フラグで所有者に与えられたパーミッションの範囲の操作を，その文書空間オブジェクトに対して実行できます。また，その文書空間オブジェクトの所有者およびセキュリティACLの値を変更できます。

スーパーインターフェース

あるインターフェースのインターフェース定義に使用されたインターフェースです。派生したインターフェースでは，スーパーインターフェースで定義されているメソッドを継承します。

スーパークラス

あるクラスのクラス定義に使用されたクラスを，派生したクラスのスーパークラスといいます。

セキュリティACL

文書空間オブジェクトに設定されたアクセス制御情報へのアクセスを制御するためのアクセス制御リストです。任意のユーザまたはグループにアクセス制御情報変更権を設定できます。

セキュリティ運用者

DocumentBrokerのアクセス制御の運用情報の管理者です。セキュリティ定義ファイルを保守します。

セキュリティ管理者

アクセス制御機能を利用した文書空間で，アクセス権判定を受けることなく，すべての文書空間オブジェクトに自由にアクセスする特権を持ち，文書空間のすべての文書空間オブジェクトを保守するユーザです。セキュリティ定義ファイルに定義します。

セキュリティ定義ファイル

アクセス制御の運用情報を定義するファイルです。セキュリティ管理者，ユーザ権限定義ファイル名，および文書空間オブジェクト作成時にアクセス制御フラグにデフォルトで設定されるパーミッションを定義します。

セッション

文書空間に接続している間のことです。文書空間に接続することを，セッションの確立といいます。文書空間との接続を解除することを，セッションの切断といいます。

セッションオブジェクト

セッションを確立する機能とセッション内のトランザクションを制御する機能を持つ，Java クラスライブラリのオブジェクトです。DbjSessionインターフェースの機能を実行できます。

セット

java.util.Setインターフェースの仕様に従うオブジェクトです。重複のない，要素オブジェクトの集合を表します。

全文検索

文書中に含まれるキーワードを条件（全文検索条件）として，キーワードを含む文書を検索する方法です。

全文検索インデクス

文書を全文検索するために，データベースに登録するインデクスです。全文検索の対象になるテキストデータに対応するedmProp_TextIndexプロパティ，edmProp_StIndexプロパティ，edmProp_ConceptTextIndexプロパティおよびedmProp_ConceptStIndexプロパティに相当します。

全文検索機能付き文書クラス

dmaClass_DocVersionクラスのサブクラスに全文検索に必要なプロパティを追加したサブクラスです。プロパティの追加は，ユーザが行います。

バージョンなし文書作成時のトップオブジェクトクラスのDMAクラス名として，またはバージョン付き文書作成時のバージョンオブジェクトのトップオブジェクトクラスのDMAクラス名として指定します。

edmSQLで全文検索を実行するときには，このDMAクラスを検索対象としてFROM句に指定します。

属性検索

文書空間オブジェクトのプロパティを対象にした検索です。例えば，「『文書名』が『X』で『作成者』が『A』の文書」のような条件を設定して検索する方法です。

（タ行）

ターゲットOIIDプロパティ

Proxyオブジェクトのプロパティです。ターゲットオブジェクトのOIIDが設定されます。

ターゲットオブジェクト

Proxyオブジェクトが対象にする文書空間オブジェクトのことです。

ターゲットオブジェクトプロパティ

リンクProxyオブジェクトのプロパティです。ターゲットリンクオブジェクトが関連付けている二つの文書空間オブジェクトのうち，リンク先オブジェクトのProxyオブジェクトが設定されます。

例えば，フォルダと文書間の直接型リンクをターゲットリンクオブジェクトとするリンクProxyオブジェクトの場合，ターゲットオブジェクトプロパティには文書のProxyオブジェクトが設定されます。

ターゲットバージョン

バージョン付きオブジェクトの複数のバージョンオブジェクトのうち，操作の対象になるバージョンです。

ターゲットバージョン識別子プロパティ

Proxyオブジェクトのプロパティです。ターゲットバージョンであるバージョンオブジェクトのバージョン識別子が設定されます。

ターゲットプロパティ値集合プロパティ

Proxyオブジェクトのプロパティです。文書空間オブジェクトからロードしたプロパティ値集合が設定されます。

ターゲットリンクオブジェクト

リンクProxyオブジェクトが対象にするリンクオブジェクトのことです。

ターゲットリンク識別子プロパティ

リンクProxyオブジェクトのプロパティです。ターゲットリンクオブジェクトのリンク識別子が設定されます。

種文章

概念検索の検索条件に指定する文章です。概念検索では，種文章を特徴付ける単語が種文章から抽出され，さらに抽出された特徴タームの中から種文章の概念を表す（実際の検索に使用する）タームが選出されます。このタームが，検索タームとして使用されます。

チェックアウト

バージョン付き文書またはバージョン付きフォルダにバージョンを追加するために，仮のバージョンを追加することです。

チェックアウト情報

バージョン付きオブジェクトのチェックアウトに関する情報です。チェックアウトしているか，チェックアウトしている場合はだれがチェックアウトしているか，また，チェックアウトしたときに設定された仮のバージョン識別子は何かについての情報です。DbjCheckOutInfoインターフェースで扱います。

チェックイン

バージョン付き文書またはバージョン付きフォルダをチェックアウトして追加した仮のバージョンを最新バージョンとして確定することです。

直接型リンク

一つのフォルダまたはバージョン付きフォルダを親として複数のオブジェクトを関連付けるリンクの種別です。ディレクトリにファイルを格納するイメージでの管理を実現します。

定数定義クラス

Java クラスライブラリのメソッドで指定する定数が定義されているDbjDefクラスおよびDbjTraceDefクラスのことです。

ディレクトリサービス

ネットワーク上にあるユーザや組織の情報などの資源とその属性を記憶し，検索できるようにしたシステムです。

DocumentBrokerでは，Active DirectoryやSun Java System Directory Serverなどの製品を使用したLDAP対応のディレクトリサービスと連携できます。

LDAP対応のディレクトリサービスとして使用できる製品の詳細については，マニュアル「DocumentBroker Version 3　システム導入・運用ガイド」を参照してください。

同義語展開検索

全文検索条件として指定する検索タームまたは検索タームの同義語を含む文書を検索する方法です。例えば，検索タームとして「パソコン」を指定した場合に，「電子計算機」，「パーソナルコンピュータ」，「PC」など，検索タームと同じ意味を持つ単語を含む文書も検索できます。

独立データ

独立したデータを表すオブジェクトです。プロパティだけを持つことができる文書空間オブジェクトです。

edmClass_IndependentPersistenceクラスまたはそのサブクラスを基に作成したDMAオブジェクトをトップオブジェクトとする文書空間オブジェクトです。

特権

アクセス制御機能を利用した文書空間で，アクセス権判定を受けることなく，すべてのオブジェクトに自由にアクセスする権利です。セキュリティ定義ファイルにセキュリティ管理者として定義されたユーザに与えられます。特権の有無は，ログイン時にセキュリティ定義ファイルが参照され，ログインユーザごとに作成されるユーザ情報に保持されます。

トップオブジェクト

文書空間オブジェクトを構成するDMAオブジェクトのうち，代表的なDMAオブジェクトです。例えば，バージョンなし文書の場合は，DocVersionオブジェクトです。

また，バージョン付きオブジェクトの場合，バージョニングオブジェクトのトップオブジェクトとバージョンオブジェクトのトップオブジェクトがあります。例えば，バージョン付き文書の場合は，ConfigurationHistoryオブジェクトとVersionTracedDocVersionオブジェクト（またはDocVersionオブジェクト）がトップオブジェクトです。

トップオブジェクトクラス

トップオブジェクトの基になるDMAクラスです。文書空間オブジェクトのプロパティの定義元になります。

トランザクション

文書空間オブジェクトの処理単位です。トランザクション単位で，文書空間オブジェクトへの操作を確定または取り消すことができます。

トランザクションの単位は，ユーザが明示的に指定できます。指定しなかった場合は，メソッド単位でトランザクションが分割されます。

トレース情報

Java クラスライブラリで発生した障害の原因を追求するための情報です。

（ナ行）

名前付き検索結果

列名が付いている検索結果集合です。列名には，edmSQL文でSELECT句に指定した項目の名前（プロパティ名など）が設定されます。

名前なし検索結果

列名が付いていない検索結果集合です。名前なし検索結果は，あとから列名を追加して，名前付き検索結果集合にすることができます。

（ハ行）

バージョニングオブジェクト

バージョン付きオブジェクトの一連のバージョンを統括する文書空間オブジェクトです。DMAオブジェクトのConfigurationHistoryオブジェクトをトップオブジェクトとする文書空間オブジェクトです。

バージョンオブジェクト

バージョン付きオブジェクトの個々のバージョンを表す文書空間オブジェクトです。

バージョン付き文書の場合は，DMAオブジェクトのVersionTracedDocVersionオブジェクト（またはDocVersionオブジェクト）をトップオブジェクトとする文書空間オブジェクトです。バージョン付きフォルダの場合は，DMAオブジェクトのContainerVersionオブジェクトをトップオブジェクトとする文書空間オブジェクトです。

バージョン管理

文書空間オブジェクトを更新する場合に，古いオブジェクトを残して新しい状態のオブジェクトを追加して，一連の履歴を管理することです。

バージョン管理権

組み合わせパーミッションの一つです。基本プロパティ参照権，基本プロパティ更新権，基本コンテンツ参照権，基本コンテンツ更新権および基本バージョン管理権を組み合わせたパーミッションです。

バージョン識別子

複数のバージョンを持つ文書空間オブジェクトの，バージョンを識別するための識別子です。特定のバージョンを指定して操作するときに使用します。この識別子はDocumentBrokerによってバージョンごとに設定される識別子であり，バージョンオブジェクトのOIIDとは異なります。

バージョン付きフォルダ

複数のバージョンを保持できるフォルダを表す文書空間オブジェクトです。

バージョン付き文書

複数のバージョンを保持できる文書を表す文書空間オブジェクトです。

バージョンなしフォルダ

バージョン管理しないフォルダを表す文書空間オブジェクトです。

バージョンなし文書

バージョン管理しない文書を表す文書空間オブジェクトです。

パーミッション

文書空間オブジェクトの作成，プロパティ参照，コンテンツ更新などの実行できる操作の範囲を表す値です。オブジェクト作成権限を与えるパーミッション，オブジェクトの操作の範囲を定めるパーミッションがあります。

バインド

文書やフォルダからパブリックACLを参照することです。

パブリックACL

文書空間オブジェクトとして存在するアクセス制御情報です。複数の文書空間オブジェクトで共有できます。

パラメタクラス

Java クラスライブラリ固有のデータをメソッドで受け渡す場合に使用するインターフェースの総称です。

ファクトリオブジェクト

DbjFactoryインターフェースの機能を実行するためのオブジェクトです。パラメタクラスのオブジェクトおよびセッションオブジェクトが作成できます。

ファクトリクラス

パラメタクラスのオブジェクトの生成，セッションオブジェクトの生成，および文書空間メタ情報アクセスインターフェースの取得を実行する，クラスならびにインターフェースです。

プライマリグループ

アクセス制御フラグ（ACFlag）でパーミッションを与えるグループです。

フラッシュ

Proxyオブジェクトのターゲットプロパティ値集合プロパティに設定した値を，文書空間オブジェクトのプロパティに反映することです。

フルコントロール

組み合わせパーミッションの一つです。すべての基本パーミッションを組み合わせたパーミッションです。文書空間オブジェクトに対するすべての操作を許可します。

プロパティ

オブジェクトに関する付加情報です。プロパティに設定される値をプロパティ値といいます。

プロパティ更新権

組み合わせパーミッションの一つです。基本プロパティ更新権と同じ操作を許可するパーミッションです。

プロパティ参照権

組み合わせパーミッションの一つです。基本プロパティ参照権と同じ操作を許可するパーミッションです。

プロパティ値集合

プロパティ名とプロパティ値の対応を要素として持つ集合です。DbjPropSetインターフェースで扱います。DbjPropSetインターフェースは，java.util.Mapインターフェースを継承しています。キーをプロパティ名，値をプロパティ値とするマップとして表されます。

Proxyオブジェクトにロードしたプロパティの値を操作したり，文書空間オブジェクトに設定するためのプロパティの値を設定したりするときに使用します。

プロパティ定義元のDMAクラス

Java クラスライブラリで扱う文書空間オブジェクトのプロパティが実際に定義されているDMAのクラスです。

プロパティディスクリプション

文書空間オブジェクトのプロパティについてのメタ情報です。プロパティごとに定義されています。

文書

dmaClass_DocVersionクラスまたはそのサブクラスをトップオブジェクトクラスとする文書空間オブジェクトです。コンテンツを保持できます。

文書管理クラス

DocumentBrokerの文書管理モデルに基づいた管理を実現するための機能を提供するインターフェースの総称です。

文書間リンク

文書と文書を関連付けるリンクの種別です。

文書空間

DMAオブジェクトモデルを実装するリポジトリです。

文書空間アクセスオブジェクト

セッションを確立した文書空間を，概念的なオブジェクトとして扱うためのオブジェクトです。DbjDocSpaceインターフェースの機能を実行できます。

文書空間オブジェクト

DocumentBrokerの文書管理で使用する，文書空間に存在するオブジェクトの総称です。

バージョンなし文書，バージョン付き文書，バージョンなしフォルダ，バージョン付きフォルダ，独立データおよびパブリックACLがあります。

文書空間識別子

セッションを確立する文書空間を特定するための識別子です。GUID文字列で表されます。

文書のアップロード情報

文書のコンテンツを更新するときに，コンテンツとして登録するファイルのパス名やファイル名，レンディションタイプなどを設定します。DbjUploadInfoインターフェースで扱います。

変換フラグ

マルチレンディション文書のサブレンディションのコンテンツを，レンディション変換の対象にするかどうかを表すフラグです。DocumentBroker Rendering Optionを使用してレンディション変換を実行する場合に使用します。また，DocumentBroker Rendering Optionによるレンディション変換でエラーが発生した場合には，エラーを示すフラグとしても使われます。dbrProp_RenditionStatusプロパティの上位2バイトに設定されます。

（マ行）

マスタレンディション

マルチレンディション文書の主要なレンディションです。マルチレンディション文書の参照・更新時には，レンディション形式を指定しますが，レンディション形式を指定しない場合は，マスタレンディションが対象になります。なお，マスタレンディションとして扱うレンディションは，登録後に変更できます。

マップ

java.util.Mapインターフェースの仕様に従うオブジェクトです。キーと値が対応付けられた要素オブジェクトの集合を表します。

マルチレンディション機能

一つの文書に，同一内容の複数の異なる形式のコンテンツを登録する機能です。

マルチレンディション文書

複数のレンディションを登録している文書のことです。一つの同じ内容を表す複数の形式のコンテンツを保持する文書です。バージョンなし文書クラスまたはバージョン付き文書クラスを使用して操作します。

メソッド

データを操作するために定義されている方法です。Java クラスライブラリでは，インターフェースおよびクラスごとにメソッドが定義されています。

メタクラス

文書空間のメタ情報を扱うためのインターフェースの総称です。

メッセージ情報

Java クラスライブラリで提供するメソッドを実行してエラーが発生したときに取得できるエラーメッセージです。

（ヤ行）

ユーザ管理システム

DocumentBrokerにログインするユーザのユーザ名や所属グループなどの情報を管理しているシステムです。LDAP対応のディレクトリサービスなどが使用できます。

なお，ログイン時の認証に必要な情報，およびアクセス制御機能に必要な情報を取得する場合は，DocumentBrokerサーバを介してユーザ管理システムにアクセスします。この場合にどのユーザ管理システムと連携するかについては，DocumentBrokerサーバで定義されています。

ユーザ権限

文書空間にオブジェクトを作成する権利（オブジェクト作成権限）と，文書空間内のすべてのオブジェクトに対する操作の範囲（オブジェクト操作権限）をユーザまたはグループ単位で定めるアクセス制御情報の一つです。ユーザ権限定義ファイルに定義します。ユーザ権限の内容は，ログイン時にユーザ権限定義ファイルが参照され，ログインユーザごとに作成されるユーザ情報に保持されます。

ユーザ権限定義ファイル

ユーザ権限（オブジェクト作成権限およびオブジェクト操作権限）を定義するためのファイルです。

ユーザ情報

ログインユーザのユーザ識別子，所属グループ，特権およびユーザ権限を表す情報です。ログイン時にユーザごとに生成され，アクセス権判定に使用されます。

ユーザ定義プロパティ

ユーザが業務に応じて追加するプロパティです。

（ラ行）

ライブラリ情報取得クラス

DocumentBroker Development KitおよびDocumentBroker Runtimeのバージョン情報を返却するメソッドを提供するクラスです。

ランキング検索

全文検索条件に対する適応度をスコアとして算出して，スコアを基に検索結果一覧をソートして出力する検索です。

リスト

java.util.Listインターフェースの仕様に従うオブジェクトです。順序付けのある要素オブジェクトの集合を表します。

リレーション種別

文書間リンクで関連付けられた文書をたどる場合に，リンク先の文書を取得するか，リンク元の文書を取得するかを指定するための種別です。

リンクProxyオブジェクト

リンクオブジェクトを操作する場合に使用する代理オブジェクトです。

リンクProxyオブジェクトは，メモリ空間に存在します。不要になった場合は，Javaのガベージコレクションによって削除されます。

リンクオブジェクト

文書空間オブジェクトの関連付けに使用するオブジェクトです。要素は，dmaClass_Relationshipクラスのサブクラスを基に作成されたDMAオブジェクトです。文書空間およびデータベースに存在する永続オブジェクトです。

リンク権

組み合わせパーミッションの一つです。基本リンク権と同じ操作を許可するパーミッションです。

リンク先オブジェクト

リンクを設定する先になる文書空間オブジェクトです。

リンク識別子

文書空間オブジェクト間（フォルダとフォルダ間またはフォルダと文書間）のリンクを識別するための識別子です。リンクを解除したり，リンクのプロパティの参照または更新したり，構成管理モードを変更したりする場合に使用します。

この識別子は関連付けをしたときにDocumentBrokerによって設定される識別子です。同じフォルダに，同じオブジェクトを2度リンク付けした場合は，それぞれ異なるリンク識別子が設定されます。

リンク種別

リンクの種類です。直接型リンク，参照型リンク，構成管理型リンク，文書間リンクがあります。なお，構成管理型リンクは，構成管理モードによって，さらに2種類の種別に分けられます。

リンク設定情報

リンクの設定に関する情報です。リンク種別，リンクオブジェクトのプロパティ，リンク先になるオブジェクトに関する情報などがあります。DbjSetLinkInfoインターフェースのサブインターフェースで表されます。なお，DbjSetLinkInfoインターフェースのサブインターフェースは，リンク種別ごとに存在します。

リンクプロパティ値集合プロパティ

リンクProxyオブジェクトのプロパティです。リンクオブジェクトからロードしたプロパティ値集合が設定されます。

リンク元オブジェクト

リンクを設定する元になる文書空間オブジェクトです。

例外クラス

Java クラスライブラリで発生する例外のうち，Java クラスライブラリ固有の例外を扱うクラスの総称です。java.lang.Exceptionクラスまたはjava.lang.Errorクラスを継承しています。

列名

検索結果集合の列に付ける名前です。edmSQL文のSELECT句に指定したプロパティ名が設定されます。

レンディション

文書のコンテンツの形式およびそのコンテンツを併せた概念です。

レンディション情報

レンディションの情報です。レンディションタイプおよびレンディションのプロパティです。DbjRenditionInfoインターフェースで扱います。

レンディション情報リスト

レンディション情報を要素としたリストです。DbjRenditionListインターフェースで扱います。

レンディションタイプ

Wordなどのアプリケーションで編集したファイル，HTML形式のファイル，GIFなどの画像データのファイルのように，登録した文書のコンテンツのファイルの形式を表す文字列です。レンディションごとに設定します。DocumentBrokerでは，レンディションタイプとして，MIME形式を指定することを推奨しています。

レンディション定義ファイル

ファイルの拡張子とレンディションタイプ（MIME形式）の対応を定義するファイルです。Java クラスライブラリがコンテンツとして登録するファイルの拡張子によってレンディションタイプ（MIME形式）を自動的に判別して設定する場合に参照されます。

レンディション変換

マルチレンディション文書のマスタレンディションのコンテンツを変換して，サブレンディションのコンテンツを作成，登録することです。

ローカルACL

文書空間オブジェクトごとに設定できるアクセス制御リスト（ACL）です。VARRAY型のプロパティとして設定されます。

ロード

文書空間オブジェクトのプロパティを，Proxyオブジェクトのターゲットプロパティ値集合プロパティに読み込むことです。

ログアウト

文書空間とのセッションを切断することです。

ログイン

文書空間とのセッションを確立することです。ログインするときには，ユーザ識別子とパスワードによる認証処理も実行されます。

ロック指定検索

検索結果集合として取得した文書空間オブジェクトに，指定した種別のロックを設定する検索です。

ロック種別

排他制御を実行するために設定する，ロックの種類です。readロックとwriteロックがあります。

ロック種別プロパティ

Proxyオブジェクトのプロパティです。そのProxyオブジェクトのインターフェースのメソッドで設定するロック種別が設定されます。

（ワ行）

ワイルドカード

文字の代わりに指定する記号です。検索する単語の一部しかわからない場合，わかっている部分にワイルドカードを付けて検索条件のキーワードとして指定します。

索引

[記号]
[Ａ][Ｂ][Ｃ][Ｄ][Ｅ][Ｆ][Ｇ][Ｈ][Ｉ][Ｊ][Ｋ][Ｌ][Ｍ][Ｎ][Ｏ][Ｐ][Ｑ][Ｒ][Ｓ][Ｔ][Ｕ][Ｖ][Ｗ][Ｘ]
[ア行][カ行][サ行][タ行][ナ行][ハ行][マ行][ヤ行][ラ行][ワ行]

(記号)

?パラメタ

?パラメタ値の取得

(英字)

(Ａ)

absolute

ACE

ACEの作成

ACEのプロパティ値集合の取得

ACEのプロパティ値集合の設定

ACFlag

ACL

aclMode（changeSearchACLMode）

addPropSet

addPropVals

addRendition

afterLast

AND条件

API（Application Programming Interface）

arg

(Ｂ)

beforeFirst

begin

bindObjectList（createPublicACL）

bindPublicACL

BOOL型の?パラメタの作成

BOOL型を表す定数

(Ｃ)

cacheKey（createFetchInfo）

cacheKey（setCacheKey）

cacheKeyプロパティ

cacheName（createFetchInfo）

cacheName（setCacheName）

cacheNameプロパティ

cacheTotal（setCacheTotal）

cacheTotalプロパティ

call

cancelCheckOut

changeMap（changePropNames）

changeMap（changePropNames）

changeMap（changeToVTFix）

changeMasterRendition

changePropName

changePropName

changePropNames

changePropNames

changeSearchACLMode

changeToVTFix

changeToVTFix

changeToVTFix

changeToVTFloat

changeToVTFloat

changeToVTFloat

checkIn

checkOut

checkOutUserIdプロパティ

checkOutVersionIdプロパティ

checkOutプロパティ

checkSession

childLinkList（link）

childList（unlink）

childObjs（link）

classListプロパティ

className（call）

className（createDocument）

className（createFolder）

className（createIndependentData）

className（createPublicACL）

className（DbjTrace）

className（getClassDesc）

classNameVersion（createVrDocument）

classNameVersion（createVrFolder）

classNameVersioning（createVrDocument）

classNameVersioning（createVrFolder）

clearParseMessage

columnIndex（getColumnMetaName）

columnIndex（getColumnName）

columnIndex（getColumnType）

columnIndex（getColumnVals）

columnIndex（getIntegerVal）

columnIndex（getIntVal）

columnIndex（getObjectRef）

columnIndex（getObjectVal）

columnIndex（getStringVal）

columnIndex（getTableName）

columnIndex（getVArrayRef）

columnIndex（getVArrayVal）

columnIndex（isNull）

columnIndex（setColumnMetaName）

columnIndexOfOiid（createObjList）

columnMetaName（setColumnMetaName）

columnName（findColumnName）

columnName（getColumnVals）

columnName（getIntegerVal）

columnName（getIntVal）

columnName（getObjectRef）

columnName（getObjectVal）

columnName（getStringVal）

columnName（getVArrayRef）

columnName（getVArrayVal）

columnName（isNull）

columnNameOfOiid（createObjList）

commit

comp（createFetchInfo）

comp（setComparator）

Comparatorインターフェースの取得

Comparatorインターフェースの設定

comparatorプロパティ

ContainerVersionオブジェクト

Containerオブジェクト

contentLocationプロパティ（DbjReferenceContentInfo）

contentOperateMode（createReferencePathInfo）

contentOperateMode（setContentOperateMode）

contentOperateModeプロパティ（DbjReferencePathInfo）

CORBA（Common Object Request Broker Architecture）

createACE

createBooleanQParam

createDocument

createFetchInfo

createFolder

createIndependentData

createInteger32QParam

createLinkObjList

createObjConnection

createObjList

createObjQParam

createOIIDQParam

createPropSet

createPublicACL

createPublicACLIdElm

createReferencePathInfo

createReferenceUploadInfo

createSeedDocQParam

createSession

createSetDCRLinkInfo

createSetRCRLinkInfo

createSetRelLinkInfo

createSetVTFixLinkInfo

createSetVTFloatLinkInfo

createStringQParam

createUploadInfo

createVArray

createVrDocument

createVrFolder

createXmlTranslator

createXmlUploadInfo

CURRENT_VERSION

(Ｄ)

DATATYPE_BOOL

DATATYPE_INT

DATATYPE_STR

DATATYPE_STRLIST

DATATYPE_UNKNOWN

DATATYPE_VARRAY

DbjAccessControlExceptionクラス

DbjAccessControlNotSupportedExceptionクラス

DbjACEOperationExceptionクラス

DbjACEインターフェース

DbjACEインターフェースのメソッド一覧

DbjACLOutOfRangeExceptionクラス

DbjAlreadyCheckOutExceptionクラス

DbjBooleanQParamインターフェース

DbjCheckOutExceptionクラス

DbjCheckOutInfoインターフェース

DbjCheckOutInfoインターフェースのメソッド一覧

DbjClassDescインターフェース

DbjClassDescインターフェースのメソッド一覧

DbjContentInfoインターフェース

DbjContentInfoインターフェースのメソッド一覧

DbjContentNotRegisteredExceptionクラス

DbjContentTypeMismatchExceptionクラス

DbjCORBAExceptionクラス

DbjDBDeadLockExceptionクラス

DbjDBExceptionクラス

DbjDBLockTimeoutExceptionクラス

DbjDefクラス

DbjDisconnectedSessionExceptionクラス

DbjDocSpaceインターフェース

DbjDocSpaceインターフェースのメソッド一覧

DbjErrorクラス

DbjExceptionクラス

DbjFactory0200クラス

DbjFactory0200クラスのメソッド一覧

DbjFactoryインターフェース

DbjFactoryインターフェースのメソッド一覧

DbjFetchInfoインターフェース

DbjFetchInfoインターフェースのメソッド一覧

DbjFileAccessExceptionクラス

DbjFileNotFoundExceptionクラス

DbjFileReferenceCurrentContentNotfoundExceptionクラス

DbjFileReferenceMismatchStatusExceptionクラス

DbjFileReferenceOperationFailedExceptionクラス

DbjIllegalCacheStartIndexExceptionクラス

DbjIllegalDocSpaceIdExceptionクラス

DbjIllegalObjectTypeExceptionクラス

DbjIllegalPropValExceptionクラス

DbjInitializeErrorクラス

DbjInteger32QParamインターフェース

DbjInternalErrorクラス

DbjIOExceptionクラス

DbjIsMasterRenditionExceptionクラス

DbjLastVersionExceptionクラス

DbjLibInfoクラス

DbjLibInfoクラスのメソッド

DbjLinkObjListインターフェース

DbjLinkObjListインターフェースのメソッド一覧

DbjLinkObjインターフェース

DbjLinkObjインターフェースのメソッド一覧

DbjMappedPropインターフェース

DbjMappedPropインターフェースのメソッド一覧

DbjMasterRenditionNotSetExceptionクラス

DbjMetaManagerインターフェース

DbjMetaManagerインターフェースのメソッド一覧

DbjMetaインターフェース

DbjMetaインターフェースのメソッド一覧

DbjNotAuthenticatedExceptionクラス

DbjNotCheckOutExceptionクラス

DbjNotLoginExceptionクラス

DbjObjectNotFoundExceptionクラス

DbjObjListインターフェース

DbjObjListインターフェースのメソッド一覧

DbjObjQParamインターフェース

DbjObjインターフェース

DbjObjインターフェースのメソッド一覧

DbjOIIDQParamインターフェース

DbjOutOfMemoryErrorクラス

DbjPropDescインターフェース

DbjPropDescインターフェースのメソッド一覧

DbjPropSetインターフェース

DbjPropSetインターフェースのメソッド一覧

DbjPublicACLAlreadyBoundExceptionクラス

DbjPublicACLIdElmインターフェース

DbjPublicACLIdElmインターフェースのメソッド一覧

DbjPublicACLNotBoundExceptionクラス

DbjPublicACLNotFoundExceptionクラス

DbjPublicACLOperationExceptionクラス

DbjPublicACLOutOfRangeExceptionクラス

DbjQParamインターフェース

DbjQParamインターフェースのメソッド一覧

DbjReferenceContentInfoインターフェース

DbjReferenceContentInfoインターフェースのメソッド一覧

DbjReferencePathInfoインターフェース

DbjReferencePathInfoインターフェースのメソッド一覧

DbjReferenceTypeMismatchExceptionクラス

DbjReferenceUploadInfoインターフェース

DbjReferenceUploadInfoインターフェースのメソッド一覧

DbjRenditionCountOutOfRangeExceptionクラス

DbjRenditionInfoインターフェース

DbjRenditionInfoインターフェースのメソッド一覧

DbjRenditionIsEmptyExceptionクラス

DbjRenditionListインターフェース

DbjRenditionListインターフェースのメソッド一覧

DbjRenditionNotConvertedExceptionクラス

DbjRenditionNotFoundExceptionクラス

DbjRenditionTypeDuplicatedExceptionクラス

DbjResultSetインターフェース

DbjResultSetインターフェースのメソッド一覧

DbjSeedDocQParamインターフェース

DbjSessionExceptionクラス

DbjSessionNotConnectExceptionクラス

DbjSessionOverflowExceptionクラス

DbjSessionインターフェース

DbjSessionインターフェースのメソッド一覧

DbjSetDCRLinkInfoインターフェース

DbjSetLinkInfoインターフェース

DbjSetLinkInfoインターフェースのメソッド一覧

DbjSetRCRLinkInfoインターフェース

DbjSetRelLinkInfoインターフェース

DbjSetVTFixLinkInfoインターフェース

DbjSetVTFloatLinkInfoインターフェース

DbjSetVTLinkInfoインターフェース

DbjStringQParamインターフェース

DbjSubjectLengthOutOfRangeExceptionクラス

DbjTargetContentPathNotSetExceptionクラス

DbjTrace

DbjTraceDefクラス

DbjTraceクラス

DbjTraceクラスのメソッド

DbjTraceクラスのメソッド

DbjUnknownErrorクラス

DbjUploadInfoインターフェース

DbjUploadInfoインターフェースのメソッド一覧

DbjVArrayインターフェース

DbjVArrayインターフェースのメソッド一覧

DbjVerObjListインターフェース

DbjVerObjListインターフェースのメソッド一覧

DbjVerObjインターフェース

DbjVerObjインターフェースのメソッド一覧

DbjXmlParseExceptionクラス

DbjXmlTranslatorインターフェース

DbjXmlTranslatorインターフェースのメソッド一覧

DbjXmlUploadInfoインターフェース

DbjXmlUploadInfoインターフェースのメソッド一覧

DEBUG

DEFAULT_DOCSPCID

deleteRendition

deleteRootPath（createReferencePathInfo）

deleteRootPath（setDeleteRootPath）

deleteRootPathプロパティ（DbjReferencePathInfo）

deleteVersion

distinct

DMA_FALSE

DMA_TRUE

DMA_UNKNOWN

DMA（Document Management Alliance）

dmaClass_ConfigurationHistoryクラス

dmaClass_Containerクラス

dmaClass_DocVersionクラス

DMAオブジェクト

DMAクラス

docspaceId（createSession）

docspaceId（createXmlTranslator）

docspaceId（getMeta）

DocVersionオブジェクト

downloadContents

(Ｅ)

edmClass_ContainerVersionクラス

edmClass_IndependentPersistenceクラス

edmClass_PublicACLクラス

edmClass_Relationshipクラス

edmClass_VersionTracedDocVersionクラス

edmSQL

edmSQL検索

enter

entry（createReferencePathInfo）

entry（setEntry）

entryプロパティ（DbjReferencePathInfo）

eqlStatement（executeSearch）

eqlStatement（removeObjects）

ERROR

error

ERRORLOG

ex（error）

executeSearch

exit

extension（getRenditionType）

(Ｆ)

fetchCount（createFetchInfo）

fetchCount（setFetchCount）

fetchCountプロパティ

fetchInfo（executeSearch）

fetchInfo（getBindObjectList）

fetchInfo（getChildList）

fetchInfo（getParentList）

fetchInfo（getRelList）

fetchInfo（getVersionObjList）

filePath（createReferenceUploadInfo）

filePath（createUploadInfo）

filePath（createXmlUploadInfo）

filePath（downloadContents）

filePath（getMappedProperties）

filePath（setFilePath）

filePathプロパティ

filePathプロパティ

filterFilePath（createXmlUploadInfo）

filterFilePath（setFilterFilePath）

filterFilePathプロパティ

findColumnName

first

fixVersionId（changeToVTFix）

fixVersionId（changeToVTFix）

(Ｇ)

getBindObjectList

getCacheKey

getCacheName

getCacheTotal

getCheckOutStatus

getCheckOutUserId

getCheckOutVersionId

getChildList

getClassDesc

getClassList

getClassName

getColumnCount

getColumnMetaName

getColumnName

getColumnType

getColumnVals

getComparator

getContentLocation

getContentOperateMode

getDataType

getDCRParent

getDeleteRootPath

getDocSpaceId

getEntry

getExtFromRenditionType

getFactory

getFetchCount

getFilePath

getFilterFilePath

getId

getIndexPath

getIndexType

getIntegerVal

getIntegerVal

getIntVal

getIntVal

getLinkId

getLinkIdList

getLinkObj

getLinkType

getLinkType

getListRef

getLockType

getLoginUserInfo

getMappedProperties

getMappingId

getMaxFetchCount

getMeta

getMeta

getMetaManager

getName

getName

getObj

getObjectRef

getObjectVal

getObjType

getOiid

getOwnerObj

getOwnerObjList

getParentList

getParseLevel

getParseMessage

getPermission

getPropCount

getPropDataType

getPropDesc

getProperties

getPropNameSet

getPropSet

getPropVals

getPublicACLList

getReferencePath

getReferencePathInfo

getReferenceType

getRelList

getRenditionInfo

getRenditionList

getRenditionType

getRenditionType

getRenditionType

getRenditionType

getRenditionTypeList

getRetrievalName

getRetrievalName

getRow

getRowCount

getRowVals

getSearchACLMode

getStartIndex

getStringVal

getStringVal

getSubClasses

getSubject

getSubjectType

getSuperClass

getTableName

getTargetObj

getTargetObj

getTargetObjList

getTargetPath

getTargetVersion

getterメソッド

getVal

getVArrayClass

getVArrayRef

getVArrayRef

getVArrayVal

getVArrayVal

getVerObj

getVersion

getVersionId

getVersionId

getVersionIdList

getVersioningInfo

getVersionObjList

grpSubject（setGroupSubject）

GUID

(Ｈ)

HINT

hint

(Ｉ)

id（setId）

Idプロパティ

index（getLinkObj）

index（getObj）

index（getRenditionInfo）

index（getVerObj）

INDEXPATH_SAME

indexPath（createreferenceuploadinfo）

indexPath（createUploadInfo）

indexPath（setIndexPath）

indexPathプロパティ

indexPathプロパティ

INDEXTYPE_NOTHING

INDEXTYPE_PLAIN

INDEXTYPE_STRUCTURED

indexType（createXmlUploadInfo）

indexType（setIndexType）

indexTypeプロパティ

init

INITIAL_KEY

Integer型でのプロパティ値の取得

Integer型での列データの取得

int型でのプロパティ値の取得

int型での列データの取得

INT型の?パラメタの作成

isAccessControlMode

isAfterLast

isAlsoChildren（removeObject）

isAlsoChildren（removeObjects）

isBeforeFirst

isCheckOut

isFirst

isLast

isNamed

isNull

isNull

(Ｊ)

Java クラスライブラリ

Java クラスライブラリのセッションオブジェクトの作成

(Ｋ)

KMBJ00001-E

KMBJ00002-E

KMBJ00003-E

KMBJ00004-E

KMBJ00005-E

KMBJ00006-E

KMBJ00007-E

KMBJ00008-E

KMBJ00009-E

KMBJ00010-E

KMBJ00011-E

KMBJ00012-E

KMBJ00013-E

KMBJ00014-E

KMBJ00015-E

KMBJ00016-E

KMBJ00017-E

KMBJ00018-E

KMBJ00019-E

KMBJ00020-E

KMBJ00021-E

KMBJ00022-E

KMBJ00023-E

KMBJ00024-E

KMBJ00025-E

KMBJ00026-E

KMBJ00027-E

KMBJ00028-E

KMBJ00029-E

KMBJ00030-E

KMBJ00031-E

KMBJ00032-E

KMBJ00033-E

KMBJ00034-E

KMBJ00035-E

KMBJ00036-E

KMBJ00037-E

KMBJ00038-E

KMBJ00039-E

KMBJ00040-E

KMBJ00041-E

KMBJ00042-E

KMBJ00043-E

KMBJ00044-E

KMBJ00045-E

KMBJ00046-E

KMBJ00047-E

KMBJ00048-E

KMBJ00049-E

KMBJ00050-E

KMBJ00051-E

KMBJ00052-E

KMBJ00053-E

KMBJ00054-E

KMBJ00055-E

KMBJ00056-E

KMBJ00057-E

KMBJ00058-E

KMBJ00059-E

KMBJ00060-E

KMBJ00061-E

KMBJ00062-E

KMBJ00063-E

KMBJ00064-E

KMBJ00065-E

KMBJ00066-E

KMBJ00067-E

KMBJ00068-E

KMBJ00069-E

KMBJ00070-E

KMBJ00071-W

KMBJ00072-E

KMBJ00073-E

KMBJ00074-E

KMBJ00075-E

KMBJ00076-E

KMBJ00077-E

KMBJ00078-E

KMBJ00079-E

KMBJ00080-E

KMBJ00081-E

KMBJ00082-E

KMBJ00083-E

KMBJ00084-E

KMBJ00085-E

KMBJ00086-E

KMBJ00087-E

KMBJ00088-E

KMBJ00089-W

KMBJ00090-W

KMBJ00091-W

KMBJ00092-E

KMBJ00093-E

KMBJ00094-E

KMBJ00095-E

KMBJ00096-E

KMBJ00097-E

KMBJ00098-E

KMBJ00099-E

KMBJ00100-E

KMBJ00101-E

KMBJ00102-E

KMBJ00103-E

KMBJ00104-E

KMBJ00105-E

KMBJ00106-E

KMBJ00107-E

KMBJ00108-E

KMBJ00109-E

KMBJ00110-E

KMBJ00111-E

KMBJ00112-E

KMBJ00113-E

KMBJ00114-E

KMBJ00115-E

KMBJ00116-W

KMBJ00117-E

KMBJ00118-W

KMBJ00119-E

KMBJ00120-E

KMBJ00121-E

KMBJ00122-E

KMBJ00123-E

KMBJ00124-E

KMBJ00125-E

KMBJ00126-E

KMBJ00127-E

KMBJ00128-E

KMBJ00129-E

KMBJ00132-E

KMBJ00133-E

KMBJ00134-E

(Ｌ)

last

level（arg）

level（call）

level（enter）

level（error）

level（hint）

level（msg）

link

LINK_ALL

LINK_DCR

LINK_NONE

LINK_RCR

LINK_REL

LINK_VT

LINK_VTFIX

LINK_VTFLOAT

linkId（changeToVTFix）

linkId（changeToVTFloat）

linkIdList（changeToVTFloat）

linkIds（unlinkByLinkId）

linkPropDefs（getChildList）

linkPropDefs（getParentList）

linkPropDefs（getRelList）

linkProps（createSetDCRLinkInfo）

linkProps（createSetRCRLinkInfo）

linkProps（createSetRelLinkInfo）

linkProps（createSetVTFixLinkInfo）

linkProps（createSetVTFloatLinkInfo）

linkType（getChildList）

linkType（getParentList）

linkType（link）

linkTypeプロパティ

List型でのプロパティ値の取得

lock

lock

LOCK_NONE

LOCK_READ

LOCK_READFORUPDATE

LOCK_WRITE

lockType（executeSearch）

lockType（lock）

lockType（lock）

login

logout

(Ｍ)

MANAGE

mappingId（createXmlUploadInfo）

mappingId（getMappedProperties）

mappingId（setMappingId）

mappingIdプロパティ

MAX_NUM

maxFetchCount（createFetchInfo）

maxFetchCount（setMaxFetchCount）

maxFetchCountプロパティ

message（error）

message（hint）

message（msg）

messageID（msg）

methodName（call）

methodName（DbjTrace）

MIME形式

move

move

msg

(Ｎ)

name（arg）

newName（changePropName）

newName（changePropName）

next

NOT条件

NULL値かどうかの判定

NULL値プロパティの設定

(Ｏ)

obj（createSetDCRLinkInfo）

obj（createSetRCRLinkInfo）

obj（createSetRelLinkInfo）

obj（createSetVTFixLinkInfo）

obj（createSetVTFloatLinkInfo）

obj（setTargetObj）

Object型の?パラメタの作成

OBJTYPE_ANY

OBJTYPE_DOC

OBJTYPE_FOLDER

OBJTYPE_IP

OBJTYPE_NVTFOLDER

OBJTYPE_PUBLICACL

OBJTYPE_UNKNOWN

OBJTYPE_VRDOC

OBJTYPE_VRFOLDER

objType（getBindObjectList）

objType（getChildList）

objType（getParentList）

objType（getRelList）

OIID

oiid（createObjConnection）

OIIDの?パラメタの作成

oldName（changePropName）

oldName（changePropName）

OPERATEMODE_NONE

OPERATEMODE_USER_RELATIVE_CONTENT

ORDER_ASC

ORDER_DESC

ORDER_NONE

order（getVersionObjList）

OR条件

output（arg）

output（call）

output（enter）

output（error）

output（hint）

output（msg）

(Ｐ)

param（createBooleanQParam）

param（createInteger32QParam）

param（createObjQParam）

param（createOIIDQParam）

param（createSeedDocQParam）

param（createStringQParam）

parentFolder（move）

parentFolder（move）

parentLinkList（createDocument）

parentLinkList（createFolder）

parentLinkList（createVrDocument）

parentLinkList（createVrFolder）

parseLevel（createXmlUploadInfo）

parseLevel（getMappedProperties）

parseLevel（setParseLevel）

parseLevelプロパティ

parseMessageプロパティ

passWord（login）

pathInfo（downloadcontents）

pathInfo（removeObject）

PERM_CHANGE_PERM

PERM_CREATE

PERM_DELETE

PERM_FULL_CONTROL

PERM_LINK

PERM_NONE

PERM_PRIM_DELETE

PERM_PRIM_LINK

PERM_PRIM_READ_CONTENTS

PERM_PRIM_READ_PROPS

PERM_PRIM_VERSION

PERM_PRIM_WRITE_CONTENTS

PERM_PRIM_WRITE_PROPS

PERM_READ

PERM_READ_PROPS

PERM_READ_WRITE

PERM_VERSION

PERM_WRITE_PROPS

permission（createACE）

permission（setPermission）

permissionプロパティ

previous

PRIV_NONE

PRIV_SECURITY_ADMINISTRATOR

PROMPT

propDefs（cancelCheckOut）

propDefs（checkIn）

propDefs（checkOut）

propDefs（createVArray）

propDefs（DbjLinkObj#readProperties）

propDefs（DbjLinkObj#writeProperties）

propDefs（DbjLinkObjList#readProperties）

propDefs（DbjLinkObjList#writeProperties）

propDefs（DbjObj#readProperties）

propDefs（DbjObj#writeProperties）

propDefs（DbjObjList#readProperties）

propDefs（DbjObjList#writeProperties）

propDefs（getBindObjectList）

propDefs（getChildList）

propDefs（getDCRParent）

propDefs（getLoginUserInfo）

propDefs（getParentList）

propDefs（getPublicACLList）

propDefs（getRelList）

propDefs（getRenditionList）

propDefs（getVersionObjList）

propName（addPropVals）

propName（getIntegerVal）

propName（getIntVal）

propName（getListRef）

propName（getPropDataType）

propName（getPropDesc）

propName（getPropVals）

propName（getStringVal）

propName（getVArrayRef）

propName（getVArrayVal）

propName（isNull）

propName（removeProp）

propName（setNull）

propName（setPropRef）

propName（setPropVal）

propSet

propSet

propSet

propSet

propSet

propSet

propSet

propSet

propSet（addPropSet）

propSet（cancelCheckOut）

propSet（checkIn）

propSet（checkOut）

propSet（createDocument）

propSet（createFolder）

propSet（createIndependentData）

propSet（createPublicACL）

propSet（createVrDocument）

propSet（createVrFolder）

propSet（DbjACE#setPropSet）

propSet（DbjLinkObj#setPropSet）

propSet（DbjLinkObj#writeProperties）

propSet（DbjLinkObjList#writeProperties）

propSet（DbjObj#setPropSet）

propSet（DbjObj#writeProperties）

propSet（DbjObjList#setPropSet）

propSet（DbjObjList#writeProperties）

propSet（DbjPublicACLIdElm#setPropSet）

propSet（DbjSetLinkInfo#setPropSet）

propSet（writeRenditionProperties）

propSetプロパティ（DbjACE）

propSetプロパティ（DbjMappedProp）

propSetプロパティ（DbjPublicACLIdElm）

propSetプロパティ（DbjRenditionInfo）

propSetプロパティ（DbjSetLinkInfo）

Proxyオブジェクト

Proxyオブジェクトのアクセスロック種別の取得

Proxyオブジェクトのプロパティ値集合インターフェースの取得

Proxyオブジェクトのプロパティ値集合の設定

publicACLId（createPublicACLIdElm）

publicACLIdList（bindPublicACL）

publicACLIdList（unbindPublicACL）

(Ｑ)

qParamList（executeSearch）

qParamList（removeObjects）

(Ｒ)

readProperties

readProperties

readProperties

readProperties

reduct

ref（setPropRef）

referencePath（setReferencePath）

referencePathInfo（createReferenceUploadInfo）

referencePathInfo（setReferencePathInfo）

referencePathInfoプロパティ（DbjReferenceUploadInfo）

REFERENCETYPE_NONE

REFERENCETYPE_USER_RELATIVE_CONTENT

referenceTypeプロパティ（DbjReferenceContentInfo）

RELATIONEND_HEAD

RELATIONEND_STATUS_ALL

RELATIONEND_STATUS_EXIST

RELATIONEND_STATUS_NOT_EXIST

RELATIONEND_TAIL

relationendType

removeObject

removeObject

removeObjects

removeObjects

removeObjects

removeProp

renditionPropSet

renditionPropSet（createReferenceUploadInfo）

renditionPropSet（createUploadInfo）

renditionPropSet（createXmlUploadInfo）

renditionPropSet（setRenditionPropSet）

renditionPropSetプロパティ

renditionPropSetプロパティ

renditionType（changeMasterRendition）

renditionType（createReferenceUploadInfo）

renditionType（createUploadInfo）

renditionType（createXmlUploadInfo）

renditionType（downloadContents）

renditionType（getExtFromRenditionType）

renditionType（setRenditionType）

renditionType（uploadContents）

renditionType（writeRenditionProperties）

renditionTypeList（deleteRendition）

renditionTypeプロパティ（DbjContentInfo）

renditionTypeプロパティ（DbjRenditionInfo）

renditionTypeプロパティ（DbjUploadInfo）

renditionTypeプロパティ（DbjXmlUploadInfo）

RENDSTATUS_CONVERT_ERROR

RENDSTATUS_CONVERT_NOTREQUIRED

RENDSTATUS_CONVERT_REQUIRED

RENDSTATUS_MASTERD

RENDSTATUS_MASTERREND_UPDATE

RENDSTATUS_NO_SUBREND

RENDSTATUS_SUBREND_EXIST

result（createObjList）

retrievalName（createReferenceUploadInfo）

retrievalName（createUploadInfo）

retrievalName（createXmlUploadInfo）

retrievalName（setRetrievalName）

retrievalNameプロパティ（DbjContentInfo）

retrievalNameプロパティ（DbjUploadInfo）

retrievalNameプロパティ（DbjXmlUploadInfo）

returned

rollback

rowIndex（absolute）

rowIndex（getPropSet）

rowIndex（getRowVals）

rowIndex（propSet）

(Ｓ)

selectItems（executeSearch）

setCacheKey

setCacheName

setCacheTotal

setColumnMetaName

setComparator

setContentOperateMode

setDeleteRootPath

setEntry

setFetchCount

setFilePath

setFilterFilePath

setGroupSubject

setId

setIndexPath

setIndexType

setMappingId

setMaxFetchCount

setNull

setParseLevel

setPermission

setPropRef

setPropSet

setPropSet

setPropSet

setPropSet

setPropSet

setPropSet

setPropVal

setReferencePath

setReferencePathInfo

setRenditionPropSet

setRenditionType

setRetrievalName

setStartIndex

setSubject

setSubjectType

setSystemSubject

setTargetObj

setTargetPath

setTargetVersion

setterメソッド

setUserSubject

src（createACE）

src（createPropSet）

src（createPublicACLIdElm）

srcObjs（createLinkObjList）

srcObjs（createObjList）

startIndex（createFetchInfo）

startIndex（setStartIndex）

startIndexプロパティ

String型でのプロパティ値の取得

String型での列データの取得

String型の?パラメタの作成

subject（createACE）

subject（setSubject）

SUBJECTTYPE_GRP

SUBJECTTYPE_SYS

SUBJECTTYPE_USR

subjectType（createACE）

subjectType（setSubjectType）

subjectTypeプロパティ

subjectプロパティ

SYSSUBJECT_EVERYONE

SYSSUBJECT_SELF

sysSubject（setSystemSubject）

SYSTEM

(Ｔ)

tableName（createObjList）

tableName（getPropSet）

targetObjプロパティ

targetPath（createReferencePathInfo）

targetPath（setTargetPath）

targetPathプロパティ（DbjReferencePathInfo）

TRACE

tracePrefix（init）

(Ｕ)

unbindPublicACL

unlink

unlinkByLinkId

uploadContents

uploadInfo（uploadContents）

uploadList（addRendition）

uploadList（createDocument）

uploadList（createVrDocument）

upName（DbjTrace）

upName（init）

userName（login）

usrSubject（setUserSubject）

(Ｖ)

val（setPropVal）

vals（addPropVals）

value（arg）

VARRAY型

VARRAY型でのデータの参照の取得

VARRAY型でのデータの取得

VARRAY型でのプロパティ値の参照の取得

VARRAY型でのプロパティ値の取得

VARRAY型プロパティを扱うクラスのクラスディスクリプションの取得

versionId（setTargetVersion）

versionIds（deleteVersion）

VersionTracedDocVersionオブジェクト

(Ｗ)

W3C

WITH_ACL

WITHOUT_ACL

writeProperties

writeProperties

writeProperties

writeProperties

writeRenditionProperties

(Ｘ)

XMLPARSE_NO_EXTERNAL_ENTITIES

XMLPARSE_VALIDATE

XMLPARSE_WITH_EXTERNAL_ENTITIES

XMLインデクスデータ作成機能

XML構造指定検索

XMLトランスレーターオブジェクト

XMLトランスレーターの取得

XMLプロパティマッピング機能

XMLプロパティマッピング結果情報

XML文書のXMLプロパティマッピング情報の作成

XML文書のアップロード情報

XML文書のアップロード情報オブジェクトの作成

XML文書の構文解析レベルを表す定数

xmsFileName（createXmlTranslator）

(ア行)

(あ)

アクセス権

アクセス指定子

アクセス指定子

アクセス制御エレメント（ACE：Access Control Element）

アクセス制御機能

アクセス制御機能付き検索

アクセス制御情報

アクセス制御情報変更権

アクセス制御フラグ（ACFlag：Access Control Flag）

アクセス制御モードの取得

アクセス制御リスト（ACL：Access Control List）

アクセス対象ターゲットバージョンのバージョン識別子の取得

アクセス対象ターゲットバージョンのバージョン識別子の変更

アクセス対象文書空間オブジェクトのOIIDの取得

アクセス対象文書空間オブジェクトのオブジェクト種別の取得

アクセス対象文書空間オブジェクトを構成するDMAクラス名の取得

アクセスロック種別の異なる複数文書空間オブジェクトインターフェースの取得

アクセスロック種別の異なる文書空間オブジェクトインターフェースの取得

アンバインド

(い)

異表記展開検索

インターフェース

(え)

永続オブジェクト

永続プロパティ

エラー情報の出力

(お)

オーナーオブジェクトプロパティ

オブジェクト作成権

オブジェクト作成権限

オブジェクト種別

オブジェクト種別プロパティ

オブジェクト種別を表す定数

オブジェクト操作権限

オブジェクトリファレンス

(カ行)

(か)

カーソルが最終行かどうかの判定

カーソルが最終行の後ろかどうかの判定

カーソルが先頭行かどうかの判定

カーソルが先頭行の前かどうかの判定

カーソル行インデクスの取得

カーソルの最終行の後ろへの移動

カーソルの最終行への移動

カーソルの絶対指定行への移動

カーソルの先頭行の前への移動

カーソルの先頭行への移動

カーソルの次の行への移動

カーソルの前の行への移動

下位オブジェクト

概念検索

下位のメソッドのエラー情報の出力

外部APIからのリターン情報の出力

外部APIの呼び出し情報の出力

拡張子に対応するレンディションタイプの取得

可変長配列

可変長配列オブジェクトの作成

可変長配列オブジェクトのプロパティ値のリストの取得

可変長配列オブジェクトのプロパティ名の一括変更

可変長配列オブジェクトのプロパティ名の変更

仮のバージョン識別子

仮のバージョン識別子の取得

カレントバージョン

(き)

基本コンテンツ更新権

基本コンテンツ参照権

基本削除権

基本バージョン管理権

基本パーミッション

基本プロパティ更新権

基本プロパティ参照権

基本リンク権

キャッシュキー

キャッシュキーの取得

キャッシュキーの設定

キャッシュ検索

キャッシュ名

キャッシュ名の取得

キャッシュ名の設定

行数の取得

行データの取得

行データをプロパティ値集合として取得

近傍条件検索

(く)

組み合わせパーミッション

クライアント共有トレースファイル

クラス，インターフェースおよびメソッドの説明形式

クラス定義情報ファイル

クラスディスクリプション

クラス名の取得

(け)

継承

検索結果キャッシュ

検索結果キャッシュの全件数の取得

検索結果キャッシュの全件数の設定

検索結果集合

検索結果取得情報

検索結果取得情報オブジェクトの作成

検索結果の最大取得件数の取得

検索結果の最大取得件数の設定

検索結果の取得開始位置の取得

検索結果の取得開始位置の設定

検索結果の取得件数の取得

検索結果の取得件数の設定

検索実行時のアクセス制御モードの取得

検索実行時のアクセス制御モードの変更

検索実行時のアクセス制御モードを表す定数

検索条件を指定したオブジェクトの削除

検索の実行

(こ)

更新系メソッド

構成管理型リンク

構成管理型リンクの構成管理モードをFIXモードに変更

構成管理型リンクの構成管理モードをFIXモードに変更

構成管理型リンクの構成管理モードをFLOATINGモードに変更

構成管理型リンクの構成管理モードをFLOATINGモードに変更

構成管理モードがFIXモードの構成管理型リンク設定情報の作成

構成管理モードがFLOATINGモードの構成管理型リンク設定情報の作成

構造指定検索

構文解析結果メッセージのクリア

構文解析結果メッセージの取得

構文解析レベルの取得

構文解析レベルの設定

コレクション

コンストラクタ

コンテンツ

コンテンツ格納先パスの取得

コンテンツ格納先パスの設定

コンテンツ格納先ベースパスの取得

コンテンツ格納先ベースパスの設定

コンテンツ情報

コンテンツのパス操作モード

コンテンツのパス操作モードの取得

コンテンツのパス操作モードの設定

コンテンツのファイル名の取得

コンテンツのレンディションタイプの取得

コンテンツロケーションの取得

(サ行)

(さ)

削除権

削除するディレクトリのルートパスの取得

削除するディレクトリのルートパスの設定

サブインターフェース

サブクラス

サブクラスのクラスディスクリプションの取得

サブジェクト

サブジェクト種別

サブジェクト種別の取得

サブジェクト種別の設定

サブジェクト種別を表す定数

サブジェクトの取得

サブジェクトの設定

サブジェクトをグループサブジェクトとして設定

サブジェクトをシステムサブジェクトとして設定

サブジェクトをユーザサブジェクトとして設定

サブレンディション

参照型リンク

参照型リンク設定情報の作成

参照系メソッド

参照権

参照更新権

サンプルWebアプリケーション

(し)

システム管理者

システムサブジェクトを表す定数

指定したクラスのクラスディスクリプションの取得

指定したプロパティのデータ型の取得

指定したプロパティのプロパティディスクリプションの取得

上位オブジェクト

状態フラグ

所有者

(す)

スーパーインターフェース

スーパークラス

スーパークラスのクラスディスクリプションの取得

(せ)

セキュリティACL

セキュリティ運用者

セキュリティ管理者

セキュリティ定義ファイル

セッション

セッションオブジェクト

セッションが有効かどうかのチェック

セット

全文検索

全文検索インデクス

全文検索インデクス作成用ファイルのフルパスの取得

全文検索インデクス作成用ファイルのフルパスの設定

全文検索インデクスの種別の取得

全文検索インデクスの種別の設定

全文検索インデクスの種別を表す定数

全文検索機能付き文書クラス

(そ)

属性検索

(タ行)

(た)

ターゲットOIIDプロパティ

ターゲットオブジェクト

ターゲットオブジェクトプロパティ

ターゲットバージョン

ターゲットバージョン識別子プロパティ

ターゲットプロパティ値集合プロパティ

ターゲットリンクオブジェクト

ターゲットリンク識別子プロパティ

ターゲットリンク識別子プロパティのリストの取得

種文章

種文章の?パラメタの作成

(ち)

チェックアウト

チェックアウトしたユーザのユーザ識別子の取得

チェックアウト情報

チェックアウト中かどうかの判定

チェックイン

直接型リンク

直接型リンクが設定されている文書空間オブジェクトの一括移動

直接型リンクが設定されている文書空間オブジェクトの移動

直接型リンク設定情報の作成

直接型リンクによるリンク元オブジェクトの取得

(て)

定数定義クラス

定数定義クラスのカテゴリ一覧

定数定義クラスのカテゴリ一覧

ディレクトリサービス

データの参照の取得

データの取得

(と)

同義語展開検索

登録するコンテンツのパスまたはダウンロード先のパスの取得

登録するコンテンツのパスまたはダウンロード先のパスの設定

登録する文書のファイル名の取得

登録する文書のファイル名の設定

登録する文書のフルパスの取得

登録する文書のフルパスの設定

登録する文書のレンディションタイプの取得

登録する文書のレンディションタイプの設定

独立データ

独立データの作成

特権

トップオブジェクト

トップオブジェクトクラス

トランザクション

トランザクションの開始

トランザクションの確定

トランザクションの取り消し

トレースクラス詳細

トレースクラスのクラス

トレースクラスのクラス，およびメソッド一覧

トレースクラスの初期化

トレースクラスのメソッド一覧

トレース出力先を表す定数

トレース情報

トレースレベルを表す定数

(ナ行)

(な)

名前付き検索結果

名前付き検索結果かどうかの判定

名前なし検索結果

名前なし列の削除

(ハ行)

(は)

バージョニングオブジェクト

バージョンオブジェクト

バージョンオブジェクトのバージョン識別子の取得

バージョン管理

バージョン管理権

バージョン識別子

バージョン情報の取得順序を表す定数

バージョン付きオブジェクトのチェックアウト

バージョン付きオブジェクトのチェックアウト状態の取得

バージョン付きオブジェクトのチェックアウトの取り消し

バージョン付きオブジェクトのチェックイン

バージョン付きオブジェクトのバージョニングオブジェクトの取得

バージョン付きオブジェクトのバージョン一覧の取得

バージョン付きフォルダ

バージョン付きフォルダの作成

バージョン付き文書

バージョン付き文書の作成

バージョンなしフォルダ

バージョンなしフォルダの作成

バージョンなし文書

バージョンなし文書の作成

バージョンの削除

バージョンの取得

パーミッション

パーミッションの取得

パーミッションの設定

パーミッションを表す定数

バインド

バインドしているパブリックACL一覧の取得

パブリックACL

パブリックACLにバインドしている文書空間オブジェクト一覧の取得

パブリックACLのOIIDエレメントの作成

パブリックACLのOIID文字列の取得

パブリックACLのOIID文字列の設定

パブリックACLのOIID文字列のプロパティ値集合の取得

パブリックACLのOIID文字列のプロパティ値集合の設定

パブリックACLのアンバインド

パブリックACLの作成

パブリックACLのバインド

パラメタクラス

パラメタクラスのインターフェース，およびメソッド一覧

パラメタクラスのインターフェース一覧

パラメタクラスのインターフェース一覧

パラメタクラスのインターフェースで説明する項目

パラメタクラスのインターフェースの継承関係

パラメタクラスのメソッド一覧

パラメタ情報の出力

(ひ)

表名の取得

(ふ)

ファクトリインターフェースの取得

ファクトリオブジェクト

ファクトリクラス

ファクトリクラスのインターフェース，およびメソッド一覧

ファクトリクラスのクラスおよびインターフェース

ファクトリクラスのクラスおよびインターフェース一覧

ファクトリクラスのメソッド一覧

フィルタリング定義ファイルのフルパスの取得

フィルタリング定義ファイルのフルパスの設定

フォルダのリンク先オブジェクト（下位オブジェクト）の取得

フォルダのリンク元オブジェクトの取得

複数の構成管理型リンクの構成管理モードを一括してFIXモードに変更

複数の構成管理型リンクの構成管理モードを一括してFLOATINGモードに変更

複数の文書空間オブジェクトアクセスインターフェースの取得

複数の文書空間オブジェクトプロパティ値の一括取得

複数の文書空間オブジェクトプロパティ値の一括設定

複数のリンクオブジェクトアクセスインターフェースの取得

プライマリグループ

フラッシュ

フルコントロール

プロパティ

プロパティ更新権

プロパティ参照権

プロパティ値（列）の追加

プロパティ値がNULL値かどうかの判定

プロパティ値集合

プロパティ値集合（行）の追加

プロパティ値集合オブジェクトの作成

プロパティ値集合の取得

プロパティ値の参照の設定

プロパティ値の設定

プロパティ定義元のDMAクラス

プロパティディスクリプション

プロパティディスクリプションの取得

プロパティの削除

プロパティのデータ型の取得

プロパティ名の一括変更

プロパティ名の取得

プロパティ名の変更

文書

文書管理クラス

文書管理クラスのインターフェース，およびメソッド一覧

文書管理クラスのインターフェース一覧

文書管理クラスのインターフェース一覧

文書管理クラスのインターフェースの継承関係

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

文書間リンク

文書間リンク一覧の取得

文書間リンク設定情報一覧の取得条件を表す定数

文書間リンク設定情報の作成

文書空間

文書空間アクセスオブジェクト

文書空間オブジェクト

文書空間オブジェクトアクセスインターフェースの取得

文書空間オブジェクトの一括削除

文書空間オブジェクトの削除

文書空間オブジェクトのバージョン識別子の取得

文書空間オブジェクトのバージョン識別子リストの取得

文書空間オブジェクトのプロパティ値の設定

文書空間オブジェクトのプロパティ値の読み込み

文書空間オブジェクトのプロパティのデータ型

文書空間オブジェクトのプロパティのデータ型を表す定数

文書空間識別子

文書空間識別子の取得

文書空間で使用する文字コード種別がUTF-8の場合の機能差異

文書空間に対するユーザの特権を表す定数

文書空間のメタ情報の取得

文書のアップロード情報

文書のアップロード情報オブジェクトの作成

文書のコンテンツのアップロード

文書のコンテンツのダウンロード

(へ)

変換フラグ

(マ行)

(ま)

マスタレンディション

マスタレンディションの変更

マッピングされたDMAクラス名のリストの取得

マッピングされたプロパティ値集合の取得

マッピング定義名の取得

マッピング定義名の設定

マップ

マルチレンディション機能

マルチレンディション文書

(め)

メソッド

メソッドで説明する項目

メソッドの入り口情報の出力

メソッドの出口情報の出力

メタクラス

メタクラスのインターフェース，およびメソッド一覧

メタクラスのインターフェース一覧

メタクラスのインターフェース一覧

メタクラスのメソッド一覧

メタ情報の取得

メタプロパティ数の取得

メタプロパティの取得

メタマネージャーインターフェースの取得

メッセージ情報

メッセージテキスト中の可変値

メッセージの形式

メッセージの形式と見方

メッセージの出力

メッセージの詳細

メッセージの見方

(ヤ行)

(ゆ)

ユーザ管理システム

ユーザ権限

ユーザ権限定義ファイル

ユーザ情報

ユーザ情報の取得

ユーザ定義プロパティ

(よ)

要素のDbjVerObjインターフェースの取得

要素のプロパティ値集合の設定

(ラ行)

(ら)

ライブラリ情報取得クラス

ライブラリ情報取得クラスのクラス

ライブラリ情報取得クラスのクラス

ライブラリ情報取得クラスのクラス，およびメソッド一覧

ライブラリ情報取得クラスのメソッド一覧

ランキング検索

(り)

リスト

リスト要素のDbjLinkObjインターフェースの取得

リスト要素の取得

リファレンス種別の取得

リファレンスタイプを表す定数

リファレンスファイル文書のアップロード情報オブジェクトの作成

リファレンスファイル文書のパス情報オブジェクトの作成

リファレンスファイル文書のパス情報の取得

リファレンスファイル文書のパス情報の設定

リレーション種別

リンクProxyオブジェクト

リンクProxyオブジェクトのプロパティ値集合インターフェースの取得

リンクProxyオブジェクトのプロパティ値集合の設定

リンクオブジェクト

リンクオブジェクトの一括削除

リンクオブジェクトの削除

リンクオブジェクトのプロパティ値集合の取得

リンクオブジェクトのプロパティ値集合の設定

リンク権

リンク先オブジェクト

リンク先オブジェクトとのリンク

リンク先オブジェクトとのリンクの解除

リンク先オブジェクトの取得

リンク先オブジェクトの取得

リンク先オブジェクトの設定

リンク先オブジェクトのリストの取得

リンク識別子

リンク識別子の指定によるリンク先オブジェクトとのリンクの解除

リンク識別子の取得

リンク種別

リンク種別の取得

リンク種別の取得

リンク種別を表す定数

リンク設定情報

リンクプロパティ値集合プロパティ

リンクプロパティ値の一括取得

リンクプロパティ値の一括設定

リンクプロパティ値の設定

リンクプロパティの取得

リンク元オブジェクト

リンク元オブジェクトの取得

リンク元オブジェクトのリストの取得

(れ)

例外クラス

例外クラスのインターフェースの継承関係

例外クラスのクラス一覧

例外クラスのクラス一覧

例外クラスのクラス一覧，スーパークラス，およびコンストラクタ

列インデクスの取得

列数の取得

列データの取得

列の重複の排除

列のデータ型の取得

列名

列名の取得

列名の取得（表名を含む）

列名の設定

レンディション

レンディション情報

レンディション情報一覧の取得

レンディション情報の取得

レンディション情報リスト

レンディションステータスを表す定数

レンディションタイプ

レンディションタイプに対応する拡張子の取得

レンディションタイプの取得

レンディションタイプのリストの取得

レンディション定義ファイル

レンディションの削除

レンディションの追加

レンディションのプロパティ値集合の取得

レンディションプロパティ値集合の取得

レンディションプロパティ値集合の設定

レンディションプロパティの設定

レンディション変換

(ろ)

ローカルACL

ロード

ログアウト

ログアウト

ログイン

ログイン

ロック指定検索

ロック種別

ロック種別プロパティ

ロック種別を表す定数

(ワ行)

(わ)

ワイルドカード

■ 商標類

Active Directoryは，米国Microsoft Corporationの，米国およびその他の国における登録商標または商標です。
AIXは，米国およびその他の国におけるInternational Business Machines Corporationの商標です。
CORBAは，Object Management Groupが提唱する分散処理環境アーキテクチャの名称です。
GIFは，米国CompuServe Inc.が開発したフォーマットの名称です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Microsoft Office Wordは，米国Microsoft Corporationの商品名称です。
Microsoftは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Microsoft Office Wordは，米国Microsoft Corporationの商品名称です。
OLEは，米国Microsoft Corporationが開発したソフトウェア名称です。
OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。
TIFFは，米国Aldus Corp.が開発したフォーマットの名称です。
UNIXは，The Open Groupの米国ならびに他の国における登録商標です。
Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
Windows Vistaは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
活文，PDFstaffは，株式会社日立ソリューションズの登録商標です。
その他記載の会社名，製品名は，それぞれの会社の商標もしくは登録商標です。