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.Core
Assembly: FileNet.Api (in filenet.api.dll)
Valid settings are:
(default setting): Allows the deletion of both the parent and child component documents.ALLOW_BOTH_DELETE
: Prevents the deletion of both the parent and child component documents.PREVENT_BOTH_DELETE
: Prevents the deletion of the parent component document.PREVENT_PARENT_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 thisPREVENT_CHILD_DELETE
object is set toComponentRelationship
(which deletes the child when the parent is deleted).CASCADE_DELETE
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property ComponentPreventDelete As ComponentPreventDeleteAction |
C# |
---|
ComponentPreventDeleteAction ComponentPreventDelete { get; set; } |
C++ |
---|
property ComponentPreventDeleteAction ComponentPreventDelete abstract { ComponentPreventDeleteAction get(); void set(ComponentPreventDeleteAction value); } |
J# |
---|
/** property */ public ComponentPreventDeleteAction get_ComponentPreventDelete(); /** property */ public void set_ComponentPreventDelete(ComponentPreventDeleteAction value); |
JScript |
---|
public function get ComponentPreventDelete() : ComponentPreventDeleteAction public function set ComponentPreventDelete(value : ComponentPreventDeleteAction); |
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