![[目次]](FIGURE/CONTENT.GIF)
uCosminexus DocumentBroker Version 5 リファレンス API
![[用語]](FIGURE/GLOSS.GIF)
![[索引]](FIGURE/INDEX.GIF)
![[前へ]](FIGURE/FRONT.GIF)
![[次へ]](FIGURE/AFTER.GIF)
パラメタクラスの各インターフェースのメソッドの一覧を示します。
DbjACEインターフェースのメソッド一覧を次の表に示します。
| メソッド | 機能 |
|---|---|
| ACEの値を取得するメソッド | |
| getPermission | パーミッションの取得 |
| getSubject | サブジェクトの取得 |
| getSubjectType | サブジェクト種別の取得 |
| propSet | ACEのプロパティ値集合の取得 |
| ACEの値を設定するメソッド | |
| setPermission | パーミッションの設定 |
| setPropSet | ACEのプロパティ値集合の設定 |
| setSubject | サブジェクトの設定 |
| setSubjectType | サブジェクト種別の設定 |
| ACEのサブジェクト種別を設定するメソッド | |
| setGroupSubject | サブジェクトをグループサブジェクトとして設定 |
| setSystemSubject | サブジェクトをシステムサブジェクトとして設定 |
| setUserSubject | サブジェクトをユーザサブジェクトとして設定 |
DbjCheckOutInfoインターフェースのメソッド一覧を次の表に示します。
表3-6 DbjCheckOutInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| チェックアウト情報を取得するメソッド | |
| getCheckOutUserId | チェックアウトしたユーザのユーザ識別子の取得 |
| getCheckOutVersionId | 仮のバージョン識別子の取得 |
| isCheckOut | チェックアウト中かどうかの判定 |
DbjContentInfoインターフェースのメソッド一覧を次の表に示します。
表3-7 DbjContentInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| 文書のコンテンツ情報を取得するメソッド | |
| getRenditionType | コンテンツのレンディションタイプの取得 |
| getRetrievalName | コンテンツのファイル名の取得 |
DbjConvertContentInfoインターフェースのメソッド一覧を次の表に示します。
表3-8 DbjConvertContentInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| 文書のコンテンツ種別の変換情報を取得するメソッド | |
| getConvertType | 変換先コンテンツ種別の取得 |
| getExecuteMode | 変換元のレンディションを残すかどうかの実行モードの取得 |
| getSourceScope | 変換対象レンディション範囲の取得 |
| getRenditionType | レンディションタイプの取得 |
| getInvestMode | コメント付与方式の取得 |
| getRenditionComment | レンディションコメントの取得 |
| getReferenceTargetPath | コンテント登録先ディレクトリパスの取得 |
| isCangeMaster | マスタレンディション変換時の変換後レンディション種別の取得 |
| isCheckRenditionStatus | レンディションステータスのチェックの取得 |
| isInvestSourceComment | レンディションコメントの付与時期の取得 |
| 文書のコンテンツ種別の変換情報を設定するメソッド | |
| setConvertType | 変換先コンテンツ種別の設定 |
| setExecuteMode | 変換元のレンディションを残すかどうかの実行モードの設定 |
| setSourceScope | 変換対象レンディション範囲の設定 |
| setRenditionType | レンディションタイプの設定 |
| setInvestMode | コメント付与方式の設定 |
| setRenditionComment | レンディションコメントの設定 |
| setReferenceTargetPath | コンテント登録先ディレクトリパスの設定 |
| setCangeMaster | マスタレンディション変換時の変換後レンディション種別の設定 |
| setCheckRenditionStatus | レンディションステータスのチェックの設定 |
| setInvestSourceComment | レンディションコメントの付与時期の設定 |
DbjFetchInfoインターフェースのメソッド一覧を次の表に示します。
表3-9 DbjFetchInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| 検索結果取得情報を取得するメソッド | |
| getCacheKey | キャッシュキーの取得 |
| getCacheName | キャッシュ名の取得 |
| getCacheTotal | 検索結果キャッシュの全件数の取得 |
| getComparator | Comparatorインターフェースの取得 |
| getFetchCount | 検索結果の取得件数の取得 |
| getMaxFetchCount | 検索結果の最大取得件数の取得 |
| getStartIndex | 検索結果の取得開始位置の取得 |
| 検索結果取得情報を設定するメソッド | |
| setCacheKey | キャッシュキーの設定 |
| setCacheName | キャッシュ名の設定 |
| setCacheTotal | 検索結果キャッシュの全件数の設定 |
| setComparator | Comparatorインターフェースの設定 |
| setFetchCount | 検索結果の取得件数の設定 |
| setMaxFetchCount | 検索結果の最大取得件数の設定 |
| setStartIndex | 検索結果の取得開始位置の設定 |
DbjPropSetインターフェースのメソッド一覧を次の表に示します。
表3-10 DbjPropSetインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| プロパティ値を取得するメソッド | |
| getIntegerVal | Integer型でのプロパティ値の取得 |
| getIntVal | int型でのプロパティ値の取得 |
| getListRef | List型でのプロパティ値の取得 |
| getStringVal | String型でのプロパティ値の取得 |
| getVArrayRef | VARRAY型でのプロパティ値の参照の取得 |
| getVArrayVal | VARRAY型でのプロパティ値の取得 |
| isNull | プロパティ値がNULL値かどうかの判定 |
| プロパティ値を設定するメソッド | |
| setNull | NULL値プロパティの設定 |
| setPropRef | プロパティ値の参照の設定 |
| setPropVal | プロパティ値の設定 |
| プロパティ名を変更するメソッド | |
| changePropName | プロパティ名の変更 |
| changePropNames | プロパティ名の一括変更 |
DbjPublicACLIdElmインターフェースのメソッド一覧を次の表に示します。
表3-11 DbjPublicACLIdElmインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| パブリックACLのOIID文字列を取得するメソッド | |
| getId | パブリックACLのOIID文字列の取得 |
| propSet | パブリックACLのOIID文字列のプロパティ値集合の取得 |
| パブリックACLのOIID文字列を設定するメソッド | |
| setId | パブリックACLのOIID文字列の設定 |
| setPropSet | パブリックACLのOIID文字列のプロパティ値集合の設定 |
DbjQParamインターフェースのメソッド一覧を次の表に示します。
表3-12 DbjQParamインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| ?パラメタ値を取得するメソッド | |
| getVal | ?パラメタ値の取得 |
DbjReferenceContentInfoインターフェースのメソッド一覧を次の表に示します。
表3-13 DbjReferenceContentInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| リファレンスファイル文書のコンテンツ情報を取得するメソッド | |
| getContentLocation | コンテンツロケーションの取得 |
| getReferenceType | リファレンス種別の取得 |
DbjReferencePathInfoインターフェースのメソッド一覧を次の表に示します。
表3-14 DbjReferencePathInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| リファレンスファイル文書のパス情報を取得するメソッド | |
| getContentOperateMode | コンテンツのパス操作モードの取得 |
| getDeleteRootPath | 削除するディレクトリのルートパスの取得 |
| getEntry | 登録するコンテンツのパスまたはダウンロード先のパスを取得 |
| getTargetPath | コンテンツ格納先バスの取得 |
| リファレンスファイル文書のパス情報を設定するメソッド | |
| setContentOperateMode | コンテンツのパス操作モードの設定 |
| setDeleteRootPath | 削除するディレクトリのルートパスの設定 |
| setEntry | 登録するコンテンツのパスまたはダウンロード先のパスの設定 |
| setTargetPath | コンテンツ格納先パスの設定 |
DbjReferenceUploadInfoインターフェースのメソッド一覧を次の表に示します。
表3-15 DbjReferenceUploadInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| リファレンスファイル文書のアップロード情報を取得するメソッド | |
| getReferencePathInfo | リファレンスファイル文書のパス情報の取得 |
| リファレンスファイル文書のアップロード情報を設定するメソッド | |
| setReferencePathInfo | リファレンスファイル文書のパス情報の設定 |
DbjRenditionInfoインターフェースのメソッド一覧を次の表に示します。
表3-16 DbjRenditionInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| レンディションタイプを取得するメソッド | |
| getRenditionType | レンディションタイプの取得 |
| propSet | レンディションタイプのプロパティ値集合の取得 |
DbjRenditionListインターフェースのメソッド一覧を次の表に示します。
表3-17 DbjRenditionListインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| レンディションタイプのリストを取得するメソッド | |
| getRenditionInfo | レンディション情報の取得 |
| getRenditionTypeList | レンディションタイプのリストの取得 |
DbjResultSetインターフェースのメソッド一覧を次の表に示します。
表3-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 | 名前なし列の削除 |
DbjSetLinkInfoインターフェースのメソッド一覧を次の表に示します。
表3-19 DbjSetLinkInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| リンク設定情報を取得するメソッド | |
| getLinkType | リンク種別の取得 |
| getTargetObj | リンク先オブジェクトの取得 |
| propSet | リンクオブジェクトのプロパティ値集合の取得 |
| リンク設定情報を設定するメソッド | |
| setPropSet | リンクオブジェクトのプロパティ値集合の設定 |
| setTargetObj | リンク先オブジェクトの設定 |
DbjUploadInfoインターフェースのメソッド一覧を次の表に示します。
表3-20 DbjUploadInfoインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| 文書のアップロード情報を取得するメソッド | |
| getFilePath | 登録する文書のフルパスの取得 |
| getIndexPath | 全文検索インデクス作成用ファイルのフルパスの取得 |
| getRenditionType | 登録する文書のレンディションタイプの取得 |
| getRetrievalName | 登録する文書のファイル名の取得 |
| renditionPropSet | レンディションプロパティ値集合の取得 |
| 文書のアップロード情報を設定するメソッド | |
| setFilePath | 登録する文書のフルパスの設定 |
| setIndexPath | 全文検索インデクス作成用ファイルのフルパスの設定 |
| setRenditionPropSet | レンディションプロパティ値集合の設定 |
| setRenditionType | 登録する文書のレンディションタイプの設定 |
| setRetrievalName | 登録する文書のファイル名の設定 |
DbjVArrayインターフェースのメソッド一覧を次の表に示します。
表3-21 DbjVArrayインターフェースのメソッド一覧
| メソッド | 機能 |
|---|---|
| 可変長配列オブジェクトのデータを取得するメソッド | |
| getPropCount | メタプロパティ数の取得 |
| getPropNameSet | メタプロパティの取得 |
| getPropVals | 可変長配列オブジェクトのプロパティ値のリストの取得 |
| propSet | プロパティ値集合の取得 |
| 可変長配列オブジェクトのデータを設定するメソッド | |
| addPropSet | プロパティ値集合（行）の追加 |
| addPropVals | プロパティ値（列）の追加 |
| removeProp | プロパティの削除 |
| 可変長配列オブジェクトのプロパティ名を変更するメソッド | |
| changePropName | 可変長配列オブジェクトのプロパティ名の変更 |
| changePropNames | 可変長配列オブジェクトのプロパティ名の一括変更 |
All Rights Reserved. Copyright (C) 2012, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2012, 2013, Hitachi Solutions, Ltd.