Content Engine Java API: DeletionAction

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

All Implemented Interfaces:

java.io.Serializable
```
public final class DeletionAction
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that identify the action to be taken with respect to an object-valued property when an attempt is made to delete the object that contains the property.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static DeletionAction`	`CASCADE` Specifies that, if the object containing a given object-valued property is deleted, any objects referenced by the property will also be deleted.
`static int`	`CASCADE_AS_INT` An `int` value associated with the CASCADE instance of this class.
`static DeletionAction`	`NONE` Specifies that, if an attempt is made to delete the object containing a given object-valued property, no special action will be taken; objects referenced by the property will not be deleted, nor will the object containing the property be prevented from being deleted.
`static int`	`NONE_AS_INT` An `int` value associated with the NONE instance of this class.
`static DeletionAction`	`PREVENT` Specifies that, if a given object-valued property has a value (references one or more objects), the deletion operation of the object containing the property will be prevented until all of the objects that the property references are deleted first.
`static int`	`PREVENT_AS_INT` An `int` value associated with the PREVENT instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static DeletionAction`	`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_AS_INT
```
public static final int PREVENT_AS_INT
```
    An int value associated with the PREVENT 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
```
public static final DeletionAction PREVENT
```
    Specifies that, if a given object-valued property has a value (references one or more objects), the deletion operation of the object containing the property will be prevented until all of the objects that the property references are deleted first. For example because a folder's SubFolders property is set to PREVENT, you will not be able to delete a folder until you first delete all of the folders referenced by its SubFolders property.
  - CASCADE_AS_INT
```
public static final int CASCADE_AS_INT
```
    An int value associated with the CASCADE 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
  - CASCADE
```
public static final DeletionAction CASCADE
```
    Specifies that, if the object containing a given object-valued property is deleted, any objects referenced by the property will also be deleted. For example because the DeletionAction property of a document's Annotations property is set to CASCADE, if you delete a document the Content Engine automatically deletes all of the annotation objects referenced by its Annotations property.
  - NONE_AS_INT
```
public static final int NONE_AS_INT
```
    An int value associated with the NONE 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
  - NONE
```
public static final DeletionAction NONE
```
    Specifies that, if an attempt is made to delete the object containing a given object-valued property, no special action will be taken; objects referenced by the property will not be deleted, nor will the object containing the property be prevented from being 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 DeletionAction 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_AS_INT

PREVENT

CASCADE_AS_INT

CASCADE

NONE_AS_INT

NONE

getValue

toString

getInstanceFromInt