uCosminexus DocumentBroker Version 3 クラスライブラリ C++ リファレンス 基本機能編

[目次][用語][索引][前へ][次へ]

付録B.1 DMAのクラスのプロパティ一覧

ここでは,クラスライブラリのオブジェクトで参照,設定できるプロパティの定義元になる,主なDMAのクラスのプロパティ一覧を示します。

<この項の構成>
(1) 説明する項目
(2) dmaClass_ConfigurationHistoryクラスのプロパティ
(3) dmaClass_Containerクラスのプロパティ
(4) dmaClass_DirectContainmentRelationshipクラスのプロパティ
(5) dmaClass_DocVersionクラスのプロパティ
(6) dmaClass_ReferentialContainmentRelationshipクラスのプロパティ
(7) dmaClass_Renditionクラスのプロパティ
(8) edmClass_ComponentDocVersionクラスのプロパティ
(9) edmClass_ContainerVersionクラスのプロパティ
(10) edmClass_ContentSearchクラスのプロパティ
(11) edmClass_IndependentPersistenceクラスのプロパティ
(12) edmClass_PublicACLクラスのプロパティ
(13) edmClass_Relationshipクラスのプロパティ
(14) edmClass_VersionTraceableContainmentRelationshipクラス
(15) edmClass_VersionTracedComponentDocVersionクラスのプロパティ
(16) edmClass_VersionTracedDocVersionクラスのプロパティ

(1) 説明する項目

各クラスの詳細は,次に示す項目に分けて説明しています。なお,DMAのクラス名について説明中では「dmaClass_DMAクラス」のように表記しています。「クラス」を除いた「dmaClass_DMA」の部分がクラス識別子です。

対応するクラスライブラリのクラス
説明するDMAのクラスと対応するクラスライブラリのクラスについて説明しています。

クラスの説明
クラスの特徴と機能,注意事項などについて説明しています。

スーパークラス
クラスの直上のスーパークラスを記述しています。

プロパティ一覧
クラスが保持するプロパティの特性を次のような一覧表で示しています。
名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_X Object型 Scalar型 dmaClass_X
プロパティの一覧表の各項目について説明します。
名前
プロパティのシステムIDを記述しています。表記の都合上,複数行にわたっている場合がありますが,実際は1行で記述します。
システム生成
DocumentBrokerが値を設定するプロパティかどうかを記述しています。
○:DocumentBrokerが値を設定するプロパティであることを示します。
−:クライアントが値を設定するプロパティであることを示します。
読み取り専用
読み取り専用のプロパティかまたは編集できるプロパティかを記述しています。
○:読み取り専用のプロパティであることを示します。
−:編集できるプロパティであることを示します。
データ型
プロパティ値のデータ型について記述しています。
基本単位
プロパティの基本単位(Scalar型,List型またはEnumeration型)について記述しています。
要求クラス
プロパティ値のデータ型がObject型の場合に,オブジェクトの基になっているクラスまたはサブクラスを記述しています。表記の都合上,複数行にわたっている場合がありますが,実際は1行で記述します。なお,要求クラスが複数ある場合は,ベースとなる共通のクラスを記述しています。

(2) dmaClass_ConfigurationHistoryクラスのプロパティ

dmaClass_ConfigurationHistoryクラスのプロパティ一覧を,次の表に示します。

表B-1 dmaClass_ConfigurationHistoryクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
Configuration
History
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
dmaProp_
Versioned
ObjectClass
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
Primary
VersionSeries
Object型 Scalar型 dmaClass_
Version
Series

(3) dmaClass_Containerクラスのプロパティ

dmaClass_Containableクラス

dmaClass_Containerクラスのプロパティ一覧を,次の表に示します。

表B-2 dmaClass_Containerクラスのプロパティ一覧

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
Container
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
dmaProp_
Children
Object型 Enumeration型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Containees
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship

(4) dmaClass_DirectContainmentRelationshipクラスのプロパティ

dmaClass_DirectContainmentRelationshipクラスのプロパティ一覧を,次の表に示します。

表B-3 dmaClass_DirectContainmentRelationshipクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_Head Object型 Scalar型 dmaClass_Containable
dmaProp_Tail Object型 Scalar型 dmaClass_Container

(5) dmaClass_DocVersionクラスのプロパティ

dmaClass_DocVersionクラスのプロパティ一覧を,次の表に示します。

表B-4 dmaClass_DocVersionクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
dmaProp_
Version
Descriptions
Object型 Enumeration型 dmaClass_
Version
Description
dmaProp_
CurrentOf
SeriesCount
Integer32型 Scalar型
dmaProp_
Renditions
Present
String型 List型
dmaProp_
Renditions
Object型 List型 dmaClass_
Rendition
edmProp_
Renditions
Count
Integer32型 Scalar型

(6) dmaClass_ReferentialContainmentRelationshipクラスのプロパティ

dmaClass_ReferentialContainmentRelationshipクラスのプロパティ一覧を,次の表に示します。

表B-5 dmaClass_ReferentialContainmentRelationshipクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_Head Object型 Scalar型 dmaClass_Containable
dmaProp_Tail Object型 Scalar型 dmaClass_Container

(7) dmaClass_Renditionクラスのプロパティ

dmaClass_Renditionクラスのプロパティ一覧を,次の表に示します。

表B-6 dmaClass_Renditionクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_RenditionType String型 Scalar型
dmaProp_ContentElementsPresent String型 List型
dmaProp_ContentElements Object型 List型 dmaClass_ContentElement

(8) edmClass_ComponentDocVersionクラスのプロパティ

edmClass_ComponentDocVersionクラスのプロパティ一覧を,次の表に示します。

表B-7 edmClass_ComponentDocVersionクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
dmaProp_
Version
Descriptions
Object型 Enumeration型 dmaClass_
Version
Description
dmaProp_
CurrentOf
SeriesCount
Integer32型 Scalar型
dmaProp_
Renditions
Present
String型 List型
dmaProp_
Renditions
Object型 List型 dmaClass_
Rendition
edmProp_CDContainers Object型 Enumeration型
edmProp_
Renditions
Count
Integer32型 Scalar型

(9) edmClass_ContainerVersionクラスのプロパティ

edmClass_ContainerVersionクラスのプロパティ一覧を,次の表に示します。

表B-8 edmClass_ContainerVersionクラス

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 edmClass_
Container
Version
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
edmProp_
VTContainers
Object型 Enumeration型 edmClass_
Version
Traceable
Containment
Relationship
dmaProp_
Children
Object型 Enumeration型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Containees
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
edmProp_
VTContainees
Object型 Enumeration型 edmClass_
Version
Traceable
Containment
Relationship
dmaProp_
Version
Descriptions
Object型 Enumeration型 dmaClass_
Version
Description
dmaProp_
CurrentOf
SeriesCount
Integer32型 Scalar型

(10) edmClass_ContentSearchクラスのプロパティ

edmClass_ContentSearchクラスのプロパティ一覧を,次の表に示します。

表B-9 edmClass_ContentSearchクラスのプロパティの一覧

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 edmClass_
Independent
Persistence
edmProp_
TextIndex
String型 Scalar型
edmProp_
StIndex
String型 Scalar型
edmProp_
ConceptText
Index
String型 Scalar型
edmProp_
ConceptSt
Index
String型 Scalar型
edmProp_
Content
String型 Scalar型
edmProp_
DocVersion
OIID
Id型 Scalar型
edmProp_
Score
Integer32型 Scalar型
edmProp_
RawScore
Integer32型 Scalar型
edmProp_
DocLength
Integer32型 Scalar型
edmProp_
ContentIndex
Status
Integer32型 Scalar型

(11) edmClass_IndependentPersistenceクラスのプロパティ

edmClass_IndependentPersistenceクラスのプロパティ一覧を,次の表に示します。

表B-10 edmClass_IndependentPersistenceクラスのプロパティの一覧

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 edmClass_
Independent
Persistence

(12) edmClass_PublicACLクラスのプロパティ

(13) edmClass_Relationshipクラスのプロパティ

edmClass_Relationshipクラスのプロパティ一覧を,次の表に示します。

表B-12 edmClass_Relationshipクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_
Head
Object型 Scalar型 dmaClass_DMA
dmaProp_
Tail
Object型 Scalar型 dmaClass_DMA
edmProp_RelationType Integer32型 Scalar型

(14) edmClass_VersionTraceableContainmentRelationshipクラス

edmClass_VersionTraceableContainmentRelationshipクラスのプロパティ一覧を,次の表に示します。

表B-13 edmClass_VersionTraceableContainmentRelationshipクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_Head Object型 Scalar型 dmaClass_Containable
dmaProp_Tail Object型 Scalar型 dmaClass_Container
edmProp_VTMode Integer32型 Scalar型
edmProp_VTVersionSeries Object型 Scalar型 dmaClass_VersionSeries
edmProp_VTConfigurationHistory Object型 Scalar型 dmaClass_ConfigurationHistory

(15) edmClass_VersionTracedComponentDocVersionクラスのプロパティ

edmClass_VersionTracedComponentDocVersionクラスのプロパティ一覧を,次の表に示します。

表B-14 edmClass_VersionTracedComponentDocVersionクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
dmaProp_
Version
Descriptions
Object型 Enumeration型 dmaClass_
Version
Description
dmaProp_
CurrentOf
SeriesCount
Integer32型 Scalar型
dmaProp_
Renditions
Present
String型 List型
dmaProp_
Renditions
Object型 List型 dmaClass_
Rendition
edmProp_CDContainers Object型 Enumeration型
edmProp_
Renditions
Count
Integer32型 Scalar型
edmProp_VTContainers Object型 Enumeration型 edmClass_VersionTraceableContainmentRelationship

(16) edmClass_VersionTracedDocVersionクラスのプロパティ

edmClass_VersionTracedDocVersionクラスのプロパティ一覧を,次の表に示します。

表B-15 edmClass_VersionTracedDocVersionクラスのプロパティ

名前 システム
生成
読み取り
専用
データ型 基本単位 要求
クラス
dmaProp_
OIID
String型 Scalar型
dmaProp_
Class
Description
Object型 Scalar型 dmaClass_
Class
Description
dmaProp_
This
Object型 Scalar型 dmaClass_
DocVersion
dmaProp_
Parent
Object型 Scalar型 dmaClass_
Direct
Containment
Relationship
dmaProp_
Parent
Container
Object型 Scalar型 dmaClass_
Container
dmaProp_
Containers
Object型 Enumeration型 dmaClass_
Referential
Containment
Relationship
dmaProp_
Version
Descriptions
Object型 Enumeration型 dmaClass_
Version
Description
dmaProp_
CurrentOf
SeriesCount
Integer32型 Scalar型
dmaProp_
Renditions
Present
String型 List型
dmaProp_
Renditions
Object型 List型 dmaClass_
Rendition
edmProp_
Renditions
Count
Integer32型 Scalar型
edmProp_VTContainers Object型 Enumeration型 edmClass_VersionTraceableContainmentRelationship