Content Engine Java API: ComponentPreventDeleteAction

java.lang.Object
- com.filenet.api.constants.ComponentPreventDeleteAction

All Implemented Interfaces:

java.io.Serializable
```
public final class ComponentPreventDeleteAction
extends java.lang.Object
implements java.io.Serializable
```
Defines settings for the delete behavior of parent and child components within a compound document. The prevention settings protect a document from deletion by causing an exception to be thrown on a deletion attempt.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ComponentPreventDeleteAction`	`ALLOW_BOTH_DELETE` Allows the deletion of both the parent and child component documents.
`static int`	`ALLOW_BOTH_DELETE_AS_INT` An `int` value associated with the ALLOW_BOTH_DELETE instance of this class.
`static ComponentPreventDeleteAction`	`PREVENT_BOTH_DELETE` Prevents the deletion of both the parent and child component documents.
`static int`	`PREVENT_BOTH_DELETE_AS_INT` An `int` value associated with the PREVENT_BOTH_DELETE instance of this class.
`static ComponentPreventDeleteAction`	`PREVENT_CHILD_DELETE` Prevents the deletion of the child component document if the parent component document exists.
`static int`	`PREVENT_CHILD_DELETE_AS_INT` An `int` value associated with the PREVENT_CHILD_DELETE instance of this class.
`static ComponentPreventDeleteAction`	`PREVENT_PARENT_DELETE` Prevents the deletion of the parent component document.
`static int`	`PREVENT_PARENT_DELETE_AS_INT` An `int` value associated with the PREVENT_PARENT_DELETE instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static ComponentPreventDeleteAction`	`getInstanceFromInt(int value)` Returns an instance of this class using its associated integer value.
`int`	`getValue()` Returns the internal integer value associated with a specific instance of this class.
`java.lang.String`	`toString()` Returns a `String` representation of this enumeration instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PREVENT_BOTH_DELETE_AS_INT
```
public static final int PREVENT_BOTH_DELETE_AS_INT
```
    An int value associated with the PREVENT_BOTH_DELETE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - PREVENT_BOTH_DELETE
```
public static final ComponentPreventDeleteAction PREVENT_BOTH_DELETE
```
    Prevents the deletion of both the parent and child component documents.
  - ALLOW_BOTH_DELETE_AS_INT
```
public static final int ALLOW_BOTH_DELETE_AS_INT
```
    An int value associated with the ALLOW_BOTH_DELETE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - ALLOW_BOTH_DELETE
```
public static final ComponentPreventDeleteAction ALLOW_BOTH_DELETE
```
    Allows the deletion of both the parent and child component documents.
  - PREVENT_PARENT_DELETE_AS_INT
```
public static final int PREVENT_PARENT_DELETE_AS_INT
```
    An int value associated with the PREVENT_PARENT_DELETE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - PREVENT_PARENT_DELETE
```
public static final ComponentPreventDeleteAction PREVENT_PARENT_DELETE
```
    Prevents the deletion of the parent component document.
  - PREVENT_CHILD_DELETE_AS_INT
```
public static final int PREVENT_CHILD_DELETE_AS_INT
```
    An int value associated with the PREVENT_CHILD_DELETE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
    
    See Also:
    Constant Field Values
  - PREVENT_CHILD_DELETE
```
public static final ComponentPreventDeleteAction 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).
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    The enumeration instance's ordinal value.
    See Also:
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static ComponentPreventDeleteAction getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    See Also:
    getValue()

Methods inherited from class java.lang.Object

PREVENT_BOTH_DELETE_AS_INT

PREVENT_BOTH_DELETE

ALLOW_BOTH_DELETE_AS_INT

ALLOW_BOTH_DELETE

PREVENT_PARENT_DELETE_AS_INT

PREVENT_PARENT_DELETE

PREVENT_CHILD_DELETE_AS_INT

PREVENT_CHILD_DELETE

getValue

toString

getInstanceFromInt