The setting that determines whether a document can be a parent component in a compound document. The
CompoundDocumentState enumeration
has constants defined for the compound document state settings.
Namespace:
FileNet.Api.CoreValid settings are:
- COMPOUND_DOCUMENT: Designates the document as the parent component in a compound document. Initially, this parent document has no child components. A document must be designated as a compound document to become a parent component for a ComponentRelationship object.
- STANDARD_DOCUMENT(default setting - 4.0.x release): Designates the document as a standard document. This setting prevents the document from being a parent component within a compound document. A document cannot be designated as a standard document when referenced as a parent component by a ComponentRelationship object.
- null (default setting - 3.5.x upgraded to 4.0.x): Designates the document as a standard document. By default, pre-existing documents in an object store upgraded to 4.0.x return a null value instead of STANDARD_DOCUMENT. Note that, although a null value can be returned, you cannot set this property to null.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property CompoundDocumentState As Nullable(Of CompoundDocumentState) |
C# |
---|
Nullable<CompoundDocumentState> CompoundDocumentState { get; set; } |
Visual C++ |
---|
property Nullable<CompoundDocumentState> CompoundDocumentState { Nullable<CompoundDocumentState> get (); void set (Nullable<CompoundDocumentState> value); } |
JavaScript |
---|
function get_compoundDocumentState(); function set_compoundDocumentState(value); |
Remarks
Metadata
AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: true
DataType: LONG
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 1
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ