The setting for the delete behavior for parent and child components. The prevention settings
protect a document from deletion by causing an exception to be thrown on a deletion attempt.
The ComponentPreventDeleteAction
enumeration has constants defined for the component prevent delete settings.
Namespace:
FileNet.Api.CoreValid settings are:
- ALLOW_BOTH_DELETE (default setting): Allows the deletion of both the parent and child component documents.
- PREVENT_BOTH_DELETE: Prevents the deletion of both the parent and child component documents.
- PREVENT_PARENT_DELETE: Prevents the deletion of the parent component document.
- PREVENT_CHILD_DELETE: Prevents the deletion of the child component document if the parent component document exists. This setting also prevents the deletion of a parent component document if the ComponentCascadeDelete property for this ComponentRelationship object is set to CASCADE_DELETE (which deletes the child when the parent is deleted).
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property ComponentPreventDelete As ComponentPreventDeleteAction |
C# |
---|
ComponentPreventDeleteAction ComponentPreventDelete { get; set; } |
Visual C++ |
---|
property ComponentPreventDeleteAction ComponentPreventDelete { ComponentPreventDeleteAction get (); void set (ComponentPreventDeleteAction value); } |
JavaScript |
---|
function get_componentPreventDelete(); function set_componentPreventDelete(value); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 3
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ