![[目次]](figure/content.gif)
uCosminexus DocumentBroker Version 3 クラスライブラリ C++ リファレンス 基本機能編
![[用語]](figure/gloss.gif)
![[索引]](figure/index.gif)
![[前へ]](figure/front.gif)
![[次へ]](figure/after.gif)
この節では，クラスライブラリの各クラスで提供するメソッドの一覧を示します。
メソッドは，上位のクラスで定義されたものがサブクラスに継承されます。例えば，CdbrDocumentクラスでは，CdbrDocumentクラスで定義されているメソッドのほか，スーパークラスであるCdbrCoreクラス，CdbrDMAクラスおよびCdbrContainableクラスで定義されているメソッドも使用できます。
なお，クラスおよびメソッドは，アルファベット順に説明します。
CdbrCompoundクラスのメソッド一覧を次の表に示します。
表1-2 CdbrCompoundクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrCompound | デストラクタ |
| CdbrCompound | コンストラクタ |
| GetCount | 要素数の取得 |
| GetDataType | 要素の型の取得 |
| GetId | 要素IDの取得 |
| GetValue | 値の取得 |
| SetValue | 値の設定 |
CdbrConfiguratedReferentialContainerクラスのメソッド一覧を次の表に示します。
表1-3 CdbrConfiguratedReferentialContainerクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrConfiguratedReferentialContainer | デストラクタ |
| CdbrConfiguratedReferentialContainer | コンストラクタ |
| CreateObject | オブジェクトの新規作成 |
| GetContainableList | 包含しているContainableオブジェクトの一覧取得 |
| GetContainableListAndLock | 包含しているContainableオブジェクトの一覧取得と同時に指定したロックの設定 |
| GetLinkPropertyValues | リンクのプロパティの取得 |
| GetLinkPropertyValuesAndLock | リンクのプロパティの取得と同時に指定したロックの設定 |
| GetVTContaineeList | 構成管理しているオブジェクトの一覧取得 |
| GetVTContaineeListAndLock | 構成管理しているオブジェクトの一覧取得と同時に指定したロックの設定 |
| Link | Containableオブジェクトとの関連づけ |
| LinkAndLock | Containableオブジェクトとの関連づけと同時に指定したロックの設定 |
| LinkVTFix | 構成管理するオブジェクトのFIXモードでの関連づけ |
| LinkVTFixAndLock | 構成管理するオブジェクトのFIXモードでの関連づけと同時に指定したロックの設定 |
| LinkVTFloat | 構成管理するオブジェクトのFLOATINGモードでの関連づけ |
| LinkVTFloatAndLock | 構成管理するオブジェクトのFLOATINGモードでの関連づけと同時に指定したロックの設定 |
| PutLinkPropertyValues | リンクのプロパティの設定 |
| SetVTFix | 構成要素のバージョンの固定 |
| SetVTFloat | 構成要素のバージョン固定の解除 |
| Unlink | Containableオブジェクトとの関連づけの解除 |
| UnlinkAndLock | Containableオブジェクトとの関連づけの解除と同時に指定したロックの設定 |
| UnlinkVT | 構成管理しているオブジェクトとの関連づけの解除 |
| UnlinkVTAndLock | 構成管理しているオブジェクトとの関連づけの解除と同時に指定したロックの設定 |
CdbrContainableクラスのメソッド一覧を次の表に示します。
表1-4 CdbrContainableクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrContainable | デストラクタ |
| BindPublicACL | パブリックACLのバインド |
| CdbrContainable | コンストラクタ |
| GetContainerList | コンテナの一覧取得 |
| GetContainerListAndLock | コンテナの一覧取得と同時に指定したロックの設定 |
| GetPublicACLList | バインドしているパブリックACL一覧情報の取得 |
| GetPublicACLListAndLock | バインドしているパブリックACL一覧情報の取得と同時に指定したロックの設定 |
| UnbindPublicACL | パブリックACLのアンバインド |
CdbrCoreクラスのメソッド一覧を次の表に示します。
表1-5 CdbrCoreクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrCore | デストラクタ |
| CdbrCore | コンストラクタ |
| GetDBError | データベースのエラーの取得 |
| GetLastError | エラー番号の取得 |
CdbrDMAクラスのメソッド一覧を次の表に示します。
表1-6 CdbrDMAクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrDMA | デストラクタ |
| CdbrDMA | コンストラクタ |
| ConnectObject | オブジェクトを指定したモードでロックして接続 |
| GetOIID | OIIDの取得 |
| GetPropertyValues | プロパティの取得 |
| GetPropertyValuesAndLock | プロパティの取得と同時に指定したロックの設定 |
| GetType | オブジェクトの種別の取得 |
| PutPropertyValues | プロパティの設定 |
| ReleaseObject | オブジェクトとの接続の解除 |
| RemoveObject | オブジェクトの削除 |
| SetOIID | OIIDの設定 |
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の変更 |
CdbrEqlStatementクラスのメソッド一覧を次の表に示します。
表1-8 CdbrEqlStatementクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrEqlStatement | デストラクタ |
| CdbrEqlStatement | コンストラクタ |
| ChangeACLMode | アクセス制御モードの変更 |
| ChangeGetObjCount | 検索結果の取得件数の変更 |
| ChangeLockType | ロック種別の変更 |
| DeleteResult | 検索結果の削除 |
| Execute | 設定済みedmSQL文の実行 |
| GetACLMode | アクセス制御モードの取得 |
| GetResult | 検索結果の取得 |
| Initialize | オブジェクトの初期化とセッションオブジェクトへの登録 |
| Set | edmSQL文の設定 |
| SetObjParam | edmSQL文の?パラメタ（DMAオブジェクト）の設定 |
| SetOIIDParam | edmSQL文の?パラメタ（OIID）の設定 |
| SetParam | edmSQL文の?パラメタの設定 |
| Terminate | セッションオブジェクトへの登録抹消 |
CdbrIndependentPersistenceクラスのメソッド一覧を次の表に示します。
表1-9 CdbrIndependentPersistenceクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrIndependentPersistence | デストラクタ |
| BindPublicACL | パブリックACLのバインド |
| CdbrIndependentPersistence | コンストラクタ |
| CreateObject | オブジェクトの新規作成 |
| GetPublicACLList | バインドしているパブリックACL一覧情報の取得 |
| GetPublicACLListAndLock | バインドしているパブリックACL一覧情報の取得と同時に指定したロックの設定 |
| UnbindPublicACL | パブリックACLのアンバインド |
CdbrPublicACLクラスのメソッド一覧を次の表に示します。
表1-10 CdbrPublicACLクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrPublicACL | デストラクタ |
| CdbrPublicACL | コンストラクタ |
| CreateObject | パブリックACLの新規作成 |
| GetBindObjectList | バインドしているオブジェクトの一覧情報の取得 |
| GetBindObjectListAndLock | バインドしているオブジェクトの一覧情報の取得と同時に指定したロックの設定 |
CdbrReferentialContainerクラスのメソッド一覧を次の表に示します。
表1-11 CdbrReferentialContainerクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrReferentialContainer | デストラクタ |
| CdbrReferentialContainer | コンストラクタ |
| CreateObject | オブジェクトの新規作成 |
| GetContainableList | 包含要素の一覧取得 |
| GetContainableListAndLock | 包含要素の一覧取得と同時に指定したロックの設定 |
| GetLinkPropertyValues | リンクのプロパティの取得 |
| GetLinkPropertyValuesAndLock | リンクのプロパティの取得と同時に指定したロックの設定 |
| Link | 関連づけの設定 |
| LinkAndLock | 関連づけの設定と同時に指定したロックの設定 |
| PutLinkPropertyValues | リンクのプロパティの設定 |
| Unlink | 関連づけの解除 |
| UnlinkAndLock | 関連づけの解除と同時に指定したロックの設定 |
CdbrSessionクラスのメソッド一覧を次の表に示します。
表1-12 CdbrSessionクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrSession | デストラクタ |
| Begin | トランザクションの開始 |
| CdbrSession | コンストラクタ |
| Commit | 永続オブジェクトの確定 |
| Connect | DocSpaceとの接続 |
| Disconnect | セッションの切断 |
| GetClassType | 指定したOIIDのクラスの判定 |
| GetDocSpaceCharacterSet | 接続する文書空間の文字コード種別の取得 |
| GetLastDetailError | 詳細エラー情報の取得 |
| GetReferencePath | コンテント格納先ベースパスの取得 |
| GetUserInfo | ユーザ情報の取得 |
| OrbComponentShutdown | TPBrokerのORBコンポーネントの終了 |
| OrbComponentStart | TPBrokerのORBコンポーネントの開始 |
| Rollback | 最後にCdbrSession::Commitメソッドがコールされた状態まで戻す |
| SetReferencePath | コンテント格納先ベースパスの設定 |
CdbrVariableArrayクラスのメソッド一覧を次の表に示します。
表1-13 CdbrVariableArrayクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrVariableArray | デストラクタ |
| Add | 要素の追加 |
| CdbrVariableArray | コンストラクタ |
| Delete | 要素の削除 |
| GetCount | 要素数の取得 |
| GetDataType | 要素の型の取得 |
| GetValue | 値の取得 |
| Resize | 要素数の変更 |
| SetValue | 値の設定 |
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 | チェックアウトの取り消し |
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の変更 |
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 | 構成管理しているオブジェクトとの関連づけの解除と同時に指定したロックの設定 |
CdbrXmlTranslatorクラスのメソッド一覧を次の表に示します。
表1-17 CdbrXmlTranslatorクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrXmlTranslator | デストラクタ |
| CdbrXmlTranslator | コンストラクタ |
| GetDmaInfoList | DMA情報の取得 |
| GetIndexData | 検索インデクス作成用データの取得 |
CdbrXmlTranslatorFactoryクラスのメソッド一覧を次の表に示します。
表1-18 CdbrXmlTranslatorFactoryクラスのメソッド一覧
| メソッド | 機能 |
|---|---|
| ~CdbrXmlTranslatorFactory | デストラクタ |
| CdbrXmlTranslatorFactory | コンストラクタ |
| CreateTranslator | CdbrXmlTranslatorオブジェクトの生成 |
| Initialize | オブジェクトの初期化 |
All Rights Reserved. Copyright (C) 2006, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2006, 2013, Hitachi Solutions, Ltd.