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サブジェクト種別の取得
propSetACEのプロパティ値集合の取得
ACEの値を設定するメソッド
setPermissionパーミッションの設定
setPropSetACEのプロパティ値集合の設定
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検索結果キャッシュの全件数の取得
getComparatorComparatorインターフェースの取得
getFetchCount検索結果の取得件数の取得
getMaxFetchCount検索結果の最大取得件数の取得
getStartIndex検索結果の取得開始位置の取得
検索結果取得情報を設定するメソッド
setCacheKeyキャッシュキーの設定
setCacheNameキャッシュ名の設定
setCacheTotal検索結果キャッシュの全件数の設定
setComparatorComparatorインターフェースの設定
setFetchCount検索結果の取得件数の設定
setMaxFetchCount検索結果の最大取得件数の設定
setStartIndex検索結果の取得開始位置の設定

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

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

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

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

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

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

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

メソッド機能
プロパティ値を取得するメソッド
getIntegerValInteger型でのプロパティ値の取得
getIntValint型でのプロパティ値の取得
getListRefList型でのプロパティ値の取得
getStringValString型でのプロパティ値の取得
getVArrayRefVARRAY型でのプロパティ値の参照の取得
getVArrayValVARRAY型でのプロパティ値の取得
isNullプロパティ値がNULL値かどうかの判定
プロパティ値を設定するメソッド
setNullNULL値プロパティの設定
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列データの取得
getIntegerValInteger型での列データの取得
getIntValint型での列データの取得
getObjectRefデータの参照の取得
getObjectValデータの取得
getPropSet行データをプロパティ値集合として取得
getRowVals行データの取得
getStringValString型での列データの取得
getVArrayRefVARRAY型でのデータの参照の取得
getVArrayValVARRAY型でのデータの取得
isNullNULL値かどうかの判定
列を削除するメソッド
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構文解析結果メッセージの取得