1.2 メソッド一覧

この節では,クラスライブラリの各クラスで提供するメソッドの一覧を示します。

メソッドは,上位のクラスで定義されたものがサブクラスに継承されます。例えば,CdbrDocumentクラスでは,CdbrDocumentクラスで定義されているメソッドのほか,スーパークラスであるCdbrCoreクラス,CdbrDMAクラスおよびCdbrContainableクラスで定義されているメソッドも使用できます。

なお,クラスおよびメソッドは,アルファベット順に説明します。

<この節の構成>
(1) CdbrCompoundクラス
(2) CdbrConfiguratedReferentialContainerクラス
(3) CdbrContainableクラス
(4) CdbrCoreクラス
(5) CdbrDMAクラス
(6) CdbrDocumentクラス
(7) CdbrEqlStatementクラス
(8) CdbrIndependentPersistenceクラス
(9) CdbrPublicACLクラス
(10) CdbrReferentialContainerクラス
(11) CdbrSessionクラス
(12) CdbrVariableArrayクラス
(13) CdbrVersionableクラス
(14) CdbrVersionableDocumentクラス
(15) CdbrVersionTraceableContainerクラス
(16) CdbrXmlTranslatorクラス
(17) CdbrXmlTranslatorFactoryクラス

(1) CdbrCompoundクラス

CdbrCompoundクラスのメソッド一覧を次の表に示します。

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

メソッド機能
~CdbrCompoundデストラクタ
CdbrCompoundコンストラクタ
GetCount要素数の取得
GetDataType要素の型の取得
GetId要素IDの取得
GetValue値の取得
SetValue値の設定

(2) CdbrConfiguratedReferentialContainerクラス

CdbrConfiguratedReferentialContainerクラスのメソッド一覧を次の表に示します。

表1-3 CdbrConfiguratedReferentialContainerクラスのメソッド一覧

メソッド機能
~CdbrConfiguratedReferentialContainerデストラクタ
CdbrConfiguratedReferentialContainerコンストラクタ
CreateObjectオブジェクトの新規作成
GetContainableList包含しているContainableオブジェクトの一覧取得
GetContainableListAndLock包含しているContainableオブジェクトの一覧取得と同時に指定したロックの設定
GetLinkPropertyValuesリンクのプロパティの取得
GetLinkPropertyValuesAndLockリンクのプロパティの取得と同時に指定したロックの設定
GetVTContaineeList構成管理しているオブジェクトの一覧取得
GetVTContaineeListAndLock構成管理しているオブジェクトの一覧取得と同時に指定したロックの設定
LinkContainableオブジェクトとの関連づけ
LinkAndLockContainableオブジェクトとの関連づけと同時に指定したロックの設定
LinkVTFix構成管理するオブジェクトのFIXモードでの関連づけ
LinkVTFixAndLock構成管理するオブジェクトのFIXモードでの関連づけと同時に指定したロックの設定
LinkVTFloat構成管理するオブジェクトのFLOATINGモードでの関連づけ
LinkVTFloatAndLock構成管理するオブジェクトのFLOATINGモードでの関連づけと同時に指定したロックの設定
PutLinkPropertyValuesリンクのプロパティの設定
SetVTFix構成要素のバージョンの固定
SetVTFloat構成要素のバージョン固定の解除
UnlinkContainableオブジェクトとの関連づけの解除
UnlinkAndLockContainableオブジェクトとの関連づけの解除と同時に指定したロックの設定
UnlinkVT構成管理しているオブジェクトとの関連づけの解除
UnlinkVTAndLock構成管理しているオブジェクトとの関連づけの解除と同時に指定したロックの設定

(3) CdbrContainableクラス

CdbrContainableクラスのメソッド一覧を次の表に示します。

表1-4 CdbrContainableクラスのメソッド一覧

メソッド機能
~CdbrContainableデストラクタ
BindPublicACLパブリックACLのバインド
CdbrContainableコンストラクタ
GetContainerListコンテナの一覧取得
GetContainerListAndLockコンテナの一覧取得と同時に指定したロックの設定
GetPublicACLListバインドしているパブリックACL一覧情報の取得
GetPublicACLListAndLockバインドしているパブリックACL一覧情報の取得と同時に指定したロックの設定
UnbindPublicACLパブリックACLのアンバインド

(4) CdbrCoreクラス

CdbrCoreクラスのメソッド一覧を次の表に示します。

表1-5 CdbrCoreクラスのメソッド一覧

メソッド機能
~CdbrCoreデストラクタ
CdbrCoreコンストラクタ
GetDBErrorデータベースのエラーの取得
GetLastErrorエラー番号の取得

(5) CdbrDMAクラス

CdbrDMAクラスのメソッド一覧を次の表に示します。

表1-6 CdbrDMAクラスのメソッド一覧

メソッド機能
~CdbrDMAデストラクタ
CdbrDMAコンストラクタ
ConnectObjectオブジェクトを指定したモードでロックして接続
GetOIIDOIIDの取得
GetPropertyValuesプロパティの取得
GetPropertyValuesAndLockプロパティの取得と同時に指定したロックの設定
GetTypeオブジェクトの種別の取得
PutPropertyValuesプロパティの設定
ReleaseObjectオブジェクトとの接続の解除
RemoveObjectオブジェクトの削除
SetOIIDOIIDの設定

(6) CdbrDocumentクラス

CdbrDocumentクラスのメソッド一覧を次の表に示します。

表1-7 CdbrDocumentクラスのメソッド一覧

メソッド機能
~CdbrDocumentデストラクタ
AddRenditionレンディションの追加
CdbrDocumentコンストラクタ
ChangeMasterRenditionマスタレンディションへの変更
ConvertContentTypeコンテント種別の変換
CreateIndex全文検索インデクスの作成
CreateObjectオブジェクトの新規作成
CreateRelation文書間リレーションの設定
DeleteRenditionレンディションの削除
GetContentファイルの取得
GetContentAndLockファイルの取得と同時に指定したロックの設定
GetContentInfoマルチファイル文書の情報の取得
GetRelationList文書のリレーション情報の一覧取得
GetRelationListAndLock文書のリレーション情報の一覧取得と同時に指定したロックの設定
GetRenditionListレンディション一覧の取得
GetRenditionListAndLockレンディション一覧の取得と同時に指定したロックの設定
GetVersionableListバージョン管理情報一覧の取得
GetVersionableListAndLockバージョン管理情報一覧の取得と同時に指定したロックの設定
PutRelationPropertyValues文書間リレーションのプロパティの設定
PutRenditionPropertyValuesレンディションのプロパティの設定
RemoveIndex全文検索インデクスの削除
RemoveRelation文書間リレーションの解除
UpdateContentファイルの更新
UpdateContentAndRenditionTypeファイルの更新およびRenditionTypeの変更

(7) CdbrEqlStatementクラス

CdbrEqlStatementクラスのメソッド一覧を次の表に示します。

表1-8 CdbrEqlStatementクラスのメソッド一覧

メソッド機能
~CdbrEqlStatementデストラクタ
CdbrEqlStatementコンストラクタ
ChangeACLModeアクセス制御モードの変更
ChangeGetObjCount検索結果の取得件数の変更
ChangeLockTypeロック種別の変更
DeleteResult検索結果の削除
Execute設定済みedmSQL文の実行
GetACLModeアクセス制御モードの取得
GetResult検索結果の取得
Initializeオブジェクトの初期化とセッションオブジェクトへの登録
SetedmSQL文の設定
SetObjParamedmSQL文の?パラメタ(DMAオブジェクト)の設定
SetOIIDParamedmSQL文の?パラメタ(OIID)の設定
SetParamedmSQL文の?パラメタの設定
Terminateセッションオブジェクトへの登録抹消

(8) CdbrIndependentPersistenceクラス

CdbrIndependentPersistenceクラスのメソッド一覧を次の表に示します。

表1-9 CdbrIndependentPersistenceクラスのメソッド一覧

メソッド機能
~CdbrIndependentPersistenceデストラクタ
BindPublicACLパブリックACLのバインド
CdbrIndependentPersistenceコンストラクタ
CreateObjectオブジェクトの新規作成
GetPublicACLListバインドしているパブリックACL一覧情報の取得
GetPublicACLListAndLockバインドしているパブリックACL一覧情報の取得と同時に指定したロックの設定
UnbindPublicACLパブリックACLのアンバインド

(9) CdbrPublicACLクラス

CdbrPublicACLクラスのメソッド一覧を次の表に示します。

表1-10 CdbrPublicACLクラスのメソッド一覧

メソッド機能
~CdbrPublicACLデストラクタ
CdbrPublicACLコンストラクタ
CreateObjectパブリックACLの新規作成
GetBindObjectListバインドしているオブジェクトの一覧情報の取得
GetBindObjectListAndLockバインドしているオブジェクトの一覧情報の取得と同時に指定したロックの設定

(10) CdbrReferentialContainerクラス

CdbrReferentialContainerクラスのメソッド一覧を次の表に示します。

表1-11 CdbrReferentialContainerクラスのメソッド一覧

メソッド機能
~CdbrReferentialContainerデストラクタ
CdbrReferentialContainerコンストラクタ
CreateObjectオブジェクトの新規作成
GetContainableList包含要素の一覧取得
GetContainableListAndLock包含要素の一覧取得と同時に指定したロックの設定
GetLinkPropertyValuesリンクのプロパティの取得
GetLinkPropertyValuesAndLockリンクのプロパティの取得と同時に指定したロックの設定
Link関連づけの設定
LinkAndLock関連づけの設定と同時に指定したロックの設定
PutLinkPropertyValuesリンクのプロパティの設定
Unlink関連づけの解除
UnlinkAndLock関連づけの解除と同時に指定したロックの設定

(11) CdbrSessionクラス

CdbrSessionクラスのメソッド一覧を次の表に示します。

表1-12 CdbrSessionクラスのメソッド一覧

メソッド機能
~CdbrSessionデストラクタ
Beginトランザクションの開始
CdbrSessionコンストラクタ
Commit永続オブジェクトの確定
ConnectDocSpaceとの接続
Disconnectセッションの切断
GetClassType指定したOIIDのクラスの判定
GetDocSpaceCharacterSet接続する文書空間の文字コード種別の取得
GetLastDetailError詳細エラー情報の取得
GetReferencePathコンテント格納先ベースパスの取得
GetUserInfoユーザ情報の取得
OrbComponentShutdownTPBrokerのORBコンポーネントの終了
OrbComponentStartTPBrokerのORBコンポーネントの開始
Rollback最後にCdbrSession::Commitメソッドがコールされた状態まで戻す
SetReferencePathコンテント格納先ベースパスの設定

(12) CdbrVariableArrayクラス

CdbrVariableArrayクラスのメソッド一覧を次の表に示します。

表1-13 CdbrVariableArrayクラスのメソッド一覧

メソッド機能
~CdbrVariableArrayデストラクタ
Add要素の追加
CdbrVariableArrayコンストラクタ
Delete要素の削除
GetCount要素数の取得
GetDataType要素の型の取得
GetValue値の取得
Resize要素数の変更
SetValue値の設定

(13) CdbrVersionableクラス

CdbrVersionableクラスのメソッド一覧を次の表に示します。

表1-14 CdbrVersionableクラスのメソッド一覧

メソッド機能
~CdbrVersionableデストラクタ
BindPublicACLパブリックACLのバインド(バージョン指定あり)
CdbrVersionableコンストラクタ
DeleteVersionバージョンの削除
GetPropertyValuesプロパティの取得(バージョン指定あり)
GetPropertyValuesAndLockプロパティの取得と同時に指定したロックの設定(バージョン指定あり)
GetPublicACLListバインドしているパブリックACL一覧情報の取得(バージョン指定あり)
GetPublicACLListAndLockバインドしているパブリックACL一覧情報の取得と同時に指定したロックの設定(バージョン指定あり)
GetReservationStatusチェックアウト状態の取得
GetReservationStatusAndLockチェックアウト状態の取得と同時に指定したロックの設定
GetVersionListバージョン情報一覧の取得
GetVersionListAndLockバージョン情報一覧の取得と同時に指定したロックの設定
PutPropertyValuesプロパティの設定(バージョン指定あり)
UnbindPublicACLパブリックACLのアンバインド(バージョン指定あり)
VersionCheckInバージョンのチェックイン
VersionCheckOutバージョンのチェックアウト
VersionRevokeチェックアウトの取り消し

(14) CdbrVersionableDocumentクラス

CdbrVersionableDocumentクラスのメソッド一覧を次の表に示します。

表1-15 CdbrVersionableDocumentクラスのメソッド一覧

メソッド機能
~CdbrVersionableDocumentデストラクタ
AddRenditionレンディションの追加
CdbrVersionableDocumentコンストラクタ
ChangeMasterRenditionマスタレンディションへの変更
ConvertContentTypeコンテント種別の変換
CreateIndex全文検索インデクスの作成
CreateObjectオブジェクトの新規作成
CreateRelation文書間リレーションの設定
DeleteRenditionレンディションの削除
GetContentファイルの取得
GetContentAndLockファイルの取得と同時に指定したロックの設定
GetContentInfoマルチファイル文書の情報の取得
GetRelationList文書のリレーション情報の一覧取得
GetRelationListAndLock文書のリレーション情報の一覧取得と同時に指定したロックの設定
GetRenditionListレンディション一覧の取得
GetRenditionListAndLockレンディション一覧の取得と同時に指定したロックの設定
PutRelationPropertyValues文書間リレーションのプロパティの設定
PutRenditionPropertyValuesレンディションのプロパティの設定
RemoveIndex全文検索インデクスの削除
RemoveRelation文書間リレーションの解除
UpdateContentファイルの更新
UpdateContentAndRenditionTypeファイルの更新およびRenditionTypeの変更

(15) CdbrVersionTraceableContainerクラス

CdbrVersionTraceableContainerクラスのメソッド一覧を次の表に示します。

表1-16 CdbrVersionTraceableContainerクラスのメソッド一覧

メソッド機能
~CdbrVersionTraceableContainerデストラクタ
CdbrVersionTraceableContainerコンストラクタ
CreateObjectオブジェクトの新規作成
GetVersionableListバージョン管理情報一覧の取得
GetVersionableListAndLockバージョン管理情報一覧の取得と同時に指定したロックの設定
GetVTContaineeList構成管理しているオブジェクトの一覧取得
GetVTContaineeListAndLock構成管理しているオブジェクトの一覧取得と同時に指定したロックの設定
LinkVTFix構成管理するオブジェクトのFIXモードでの関連づけ
LinkVTFixAndLock構成管理するオブジェクトのFIXモードでの関連づけと同時に指定したロックの設定
LinkVTFloat構成管理するオブジェクトのFLOATINGモードでの関連づけ
LinkVTFloatAndLock構成管理するオブジェクトのFLOATINGモードでの関連づけと同時に指定したロックの設定
SetVTFix構成要素のバージョンの固定
SetVTFixAndLock構成要素のバージョンの固定と同時に指定したロックの設定
SetVTFloat構成要素のバージョン固定の解除
SetVTFloatAndLock構成要素のバージョン固定の解除と同時に指定したロックの設定
UnlinkVT構成管理しているオブジェクトとの関連づけの解除
UnlinkVTAndLock構成管理しているオブジェクトとの関連づけの解除と同時に指定したロックの設定

(16) CdbrXmlTranslatorクラス

CdbrXmlTranslatorクラスのメソッド一覧を次の表に示します。

表1-17 CdbrXmlTranslatorクラスのメソッド一覧

メソッド機能
~CdbrXmlTranslatorデストラクタ
CdbrXmlTranslatorコンストラクタ
GetDmaInfoListDMA情報の取得
GetIndexData検索インデクス作成用データの取得

(17) CdbrXmlTranslatorFactoryクラス

CdbrXmlTranslatorFactoryクラスのメソッド一覧を次の表に示します。

表1-18 CdbrXmlTranslatorFactoryクラスのメソッド一覧

メソッド機能
~CdbrXmlTranslatorFactoryデストラクタ
CdbrXmlTranslatorFactoryコンストラクタ
CreateTranslatorCdbrXmlTranslatorオブジェクトの生成
Initializeオブジェクトの初期化