com.filenet.api.constants
Class ComponentCascadeDeleteAction

java.lang.Object
  extended by com.filenet.api.constants.ComponentCascadeDeleteAction
All Implemented Interfaces:
java.io.Serializable

public final class ComponentCascadeDeleteAction
extends java.lang.Object
implements java.io.Serializable

Defines settings for controlling the deletion of a child component as an automatic response to the deletion of the parent component within a compound document.

See Also:
Serialized Form

Field Summary
static ComponentCascadeDeleteAction CASCADE_DELETE
          Causes the child component document to be automatically deleted when the parent component document is deleted.
static int CASCADE_DELETE_AS_INT
          An int value associated with the CASCADE_DELETE instance of this class.
static ComponentCascadeDeleteAction NO_CASCADE_DELETE
          Causes no special action to occur when the parent component document is deleted.
static int NO_CASCADE_DELETE_AS_INT
          An int value associated with the NO_CASCADE_DELETE instance of this class.
 
Method Summary
static ComponentCascadeDeleteAction 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

NO_CASCADE_DELETE_AS_INT

public static final int NO_CASCADE_DELETE_AS_INT
An int value associated with the NO_CASCADE_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

NO_CASCADE_DELETE

public static final ComponentCascadeDeleteAction NO_CASCADE_DELETE
Causes no special action to occur when the parent component document is deleted.


CASCADE_DELETE_AS_INT

public static final int CASCADE_DELETE_AS_INT
An int value associated with the CASCADE_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

CASCADE_DELETE

public static final ComponentCascadeDeleteAction CASCADE_DELETE
Causes the child component document to be automatically deleted when the parent component document 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 ComponentCascadeDeleteAction 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()


© Copyright IBM Corporation 2006, 2008. All rights reserved.