CdbrDocumentクラスの詳細
表8-1 CdbrDocumentクラスのプロパティ
プロパティ名 | プロパティ識別子 | データ型 | 読み取り専用 |
---|---|---|---|
OIID | dmaProp_OIID | String型 | ○ |
ParentCount | dbrProp_ParentCount | Integer32型 | ○ |
ContainersCount | dbrProp_ContainersCount | Integer32型 | ○ |
ContainersCountVT | dbrProp_ContainersCountVT | Integer32型 | ○ |
RenditionType | dbrProp_RenditionType | String型 | ○ |
RetrievalName | dbrProp_RetrievalName | String型 | - |
HeadRelationsCount | dbrProp_HeadRelationsCount | Integer32型 | ○ |
TailRelationsCount | dbrProp_TailRelationsCount | Integer32型 | ○ |
RenditionStatus | dbrProp_RenditionStatus | Integer32型 | ○ |
ContentType | dbrProp_ContentType | Integer32型 | ○ |
ReferenceType | dbrProp_ReferenceType | Integer32型 | ○ |
ContentLocation | dbrProp_ContentLocation | String型 | ○ |
表8-2 CdbrDocumentクラスのプロパティ(アクセス制御機能を使用する場合に追加されるクラスライブラリ固有のプロパティ)
プロパティ名 | プロパティ識別子 | データ型※1 | 読み取り専用 |
---|---|---|---|
OwnerId | dbrProp_OwnerId | String型 | -※2 |
UserPermission | dbrProp_UserPermission | Integer32型 | ○ |
PrimaryGroupId | dbrProp_PrimaryGroupId | String型 | -※3 |
ACL | dbrProp_ACL | Object型 (VariableArray型) | -※3 |
SACL | dbrProp_SACL | Object型 (VariableArray型) | -※2 |
OwnerPermission | dbrProp_OwnerPermission | Integer32型 | -※3 |
PrimaryGroupPermission | dbrProp_PrimaryGroupPermission | Integer32型 | -※3 |
EveryonePermission | dbrProp_EveryonePermission | Integer32型 | -※3 |
PublicACLCount | dbrProp_PublicACLCount | Integer32型 | ○ |
PublicACLIds | dbrProp_PublicACLIds | Object型 (VariableArray型) | -※3 |
表8-3 RenditionStatusプロパティの値(状態フラグ:下位2バイト)
定数 | 対応する値 (16進数) | 説明 |
---|---|---|
DBR_RENDSTATUS_NO_SUBREND | 0001 | 指定したサブレンディションに対応するマスタレンディションのコンテントは登録済みですが,サブレンディションのコンテントが未登録です。 |
DBR_RENDSTATUS_SUBREND_EXIST | 0002 | 指定したサブレンディションに対応するマスタレンディションおよびサブレンディションのコンテントが登録されています。 |
DBR_RENDSTATUS_MASTERREND_UPDATE | 0004 | 指定したサブレンディションに対応するマスタレンディションが更新されていますが,サブレンディションが更新されていないため,マスタレンディションとサブレンディションの内容が不一致です。 |
表8-4 RenditionStatusプロパティの値(変換フラグ:上位2バイト)
定数 | 対応する値 (16進数) | 説明 |
---|---|---|
DBR_RENDSTATUS_CONVERT_NOTREQUIRED | 0000 | レンディション変換が不要な状態です。この状態の場合,DocumentBroker Rendering Optionによるレンディション変換の対象になりません。 |
DBR_RENDSTATUS_CONVERT_REQUIRED | 0001 | レンディション変換が必要な状態です。この状態の場合,DocumentBroker Rendering Optionによるレンディション変換の対象になります。 |
DBR_RENDSTATUS_CONVERT_ERROR | 0002 | DocumentBroker Rendering Optionによるレンディション変換時にエラーが発生した状態です。この状態になると,DocumentBroker Rendering Optionによるレンディション変換はできなくなります。 |
表8-5 ContentTypeプロパティの値とコンテント種別の関係
dbrProp_ContentTypeの値 | 対応する値 | コンテント種別 |
---|---|---|
DBR_CONTENTTYPE_CONTENT | 0 | ContentTransferオブジェクト(シングルファイル文書であるコンテント)です。 |
DBR_CONTENTTYPE_FILELINK | 1 | ContentFileLinkオブジェクト(File Link文書であるコンテント)です。 |
DBR_CONTENTTYPE_MULTIFILE | 2 | ContentTransfersオブジェクト(マルチファイル文書であるコンテント)です。 |
DBR_CONTENTTYPE_REFERENCE | 3 | ContentReferenceオブジェクト(リファレンスファイル文書であるコンテント)です。 |
DBR_CONTENTTYPE_OTHER | -1 | 上記以外のコンテントを持つオブジェクトです。 |
表8-6 ReferenceTypeプロパティの値とリファレンス種別の関係
dbrProp_ReferenceTypeの値 | 対応する値 | リファレンス種別 |
---|---|---|
DBR_REFERENCETYPE_NONE | 0 | コンテントはありません。 |
DBR_REFERENCETYPE_USER_RELATIVE_CONTENT | 1001 | ユーザ管理領域に格納したコンテント(相対パス)です。 |
なお,このほかに,CdbrDocumentクラスでは,構成要素であるDMAオブジェクトを作成する基になるDMAのクラスのdmaClass_DocVersionクラスおよびそのサブクラスのプロパティを参照,設定できます。DMAのクラスのプロパティについては,「付録B DMAオブジェクトのプロパティ」を参照してください。
メソッド | 機能 |
---|---|
~CdbrCore | デストラクタ |
CdbrCore | コンストラクタ |
GetDBError | データベースのエラーの取得 |
GetLastError | エラー番号の取得 |
メソッド | 機能 |
---|---|
~CdbrDMA | デストラクタ |
CdbrDMA | コンストラクタ |
ConnectObject | オブジェクトを指定したモードでロックして接続 |
GetOIID | OIIDの取得 |
GetPropertyValues | プロパティの取得 |
GetPropertyValuesAndLock | プロパティの取得と同時に指定したロックの設定 |
GetType | オブジェクトの種別の取得 |
PutPropertyValues | プロパティの設定 |
ReleaseObject | オブジェクトとの接続の解除 |
RemoveObject | オブジェクトの削除 |
SetOIID | OIIDの設定 |
メソッド | 機能 |
---|---|
~CdbrContainable | デストラクタ |
BindPublicACL | パブリックACLのバインド |
CdbrContainable | コンストラクタ |
GetContainerList | コンテナの一覧取得 |
GetContainerListAndLock | コンテナの一覧取得と同時に指定したロックの設定 |
GetPublicACLList | バインドしているパブリックACL一覧情報の取得 |
GetPublicACLListAndLock | バインドしているパブリックACL一覧情報の取得と同時に指定したロックの設定 |
UnbindPublicACL | パブリックACLのアンバインド |
メソッド | 機能 |
---|---|
~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の変更 |
以降,CdbrDocumentクラスで導入されるメソッドについて説明します。